Playwright設定ファイル（jpc_playwright.config.ts）

〈このページの構成〉

形式
ファイル
格納先ディレクトリ
説明
文字コード
改行コード
定義の反映時期
記述内容

形式

import { defineConfig, devices } from '../lib/playwright/node_modules/@playwright/test';
 
export default defineConfig({
  name: 'test_1',
  testDir: '../lib/playwright/tests',
  fullyParallel: false,
　：
（略）
　：
  use: {
    deviceScaleFactor: 1,
    acceptDownloads: false,
    ignoreHTTPSErrors: false,
　：
（略）
　：
  },
 
  projects: [
    {
      name: 'project_1',
      testMatch: /.*/,
      use: {
        trace: {
          mode: 'on',
          attachments: false,
          screenshots: true,
          snapshots: false,
          sources: false,
          },
       },
    },
  ],
});

ページの先頭へ

ファイル

jpc_playwright.config.ts

jpc_playwright.config.ts.model（モデルファイル）

ページの先頭へ

格納先ディレクトリ

■統合エージェントホスト

Windowsの場合

物理ホストのとき（定義ファイルおよびモデルファイル）

Agentパス\conf\
論理ホストのとき（定義ファイル）

共有フォルダ\jp1ima\conf\

ページの先頭へ

説明

Playwrightの動作を規定する設定ファイルです。

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

CR+LF

ページの先頭へ

定義の反映時期

Web exporterによるWebシナリオ実行時に，Playwrightの動作に反映されます。

ページの先頭へ

記述内容

項目名				説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentの初期値
name				テスト全体の名称を指定します。指定した名称がトレースファイルパス名に格納されます。このパラメーター（グローバルのname）とprojectsのnameを両方指定した場合は，projects内のnameが優先されます。このパラメーター（グローバルのname）とprojects内のnameを両方省略した場合は，無名のテストとなり，トレースファイルパス名にテストの名前が使用されません。注　projects内のnameは，各テストの名称を個別に指定するパラメーターです。	〇	テスト全体の名称を指定します。トレースファイルの格納先フォルダ名の文字数が，全角・半角文字で255文字以内となるように指定します。全角文字と半角文字は，それぞれ1文字として計算します。	test_1
testDir				テストファイルを呼び出すフォルダを指定します。	△	−	testDir
fullyParallel				テストを並行に行うかどうかを指定します。	△	−	false
globalTimeout				一連のテスト実行で処理を打ち切る時間（単位：ミリ秒）を指定します。値が0の場合は，テストを打ち切りません。	△	−	0
ignoreSnapshots				スナップショットをスキップするかどうかを指定します。	△	−	true
maxFailures				1回の実行で行うすべてのテストプロジェクトにおける失敗の上限回数を指定します。上限回数に到達すると，テストは終了し，エラーとなります。retriesが各テストでのリトライ回数の上限を指定するのに対し，maxFailureは全体の合計の失敗数を指定します。値が「0」のときは上限なしとなります。	〇	テスト全体の失敗上限回数を0〜2の範囲で指定します。	0
preserveOutput				テスト生成物を保存するかどうかを指定します。	△	−	always
quiet				テスト実行時にstdioおよびstderrの出力を抑えるかどうかを指定します。	△	−	false
repeatEach				各テストを繰り返す回数を指定します。フレーキーテスト（実行結果が不安定なテスト）のデバッグに使用できます。	△	−	1
retries				テスト失敗時のリトライ回数の上限を指定します。このパラメーターを指定した場合，テストが失敗しても，成功するか，指定した上限回数に達するまで，テストをリトライします。	〇	各テストの失敗時におけるリトライ上限回数を0〜2の範囲で指定します。	0
timeout				テストのタイムアウト時間をミリ秒で指定します。テスト機能，フィクスチャ，およびbeforeEachとafterEachのフックが，タイムアウト時間に含まれます。 timeoutは，全テストのベースとなるタイムアウト時間となります。各テストのタイムアウト時間は，test.setTimeout()関数で設定できます。	△	−	0
updateSnapshots				予想されるスナップショットを，テストの実行によって生成された結果で更新するかどうかを指定します。	△	−	none
workers				テストの同時実行数の上限を指定します。 CPUの使用率に応じた上限の指定をすることもできます。	△	−	1
use				すべてのテストのグローバルオプションの設定です。	〇	−	−
	deviceScaleFactor			デバイスのスケールファクター（dprと同等）を指定します。デフォルト値は「1」です。	△	−	1
	viewport			各ページの一貫したビューポートの操作の設定です。	△	−	−
		width		ページの幅のピクセル数を指定します。	△	−	1280
		height		ページの高さのピクセル数を指定します。	△	−	720
	acceptDownloads			添付ファイルを自動的にダウンロードするかどうかを指定します。	△	−	false
	ignoreHTTPSErrors			ネットワークリクエストを送るときに，TLS通信内の認証でサーバ証明書が正しくない場合に生じるHTTPSエラーを無視するかどうかを指定します。	〇	次のどちらかを指定できます。 true HTTPSエラーを無視して処理を継続する。 false 処理を停止させる。	false
	javaScriptEnabled			コンテクストでJavaScriptを有効にするかどうかを指定します。	〇	次のどちらかを指定できます。 true JavaScriptを有効にする。 false JavaScriptを無効にする。	true
	launchOptions			browserNameがchromiumで，use.proxyパラメーターを指定する場合に使用します。	〇	−	−
		proxy		browserNameがchromiumで，use.proxyパラメーターを指定する場合に使用します。	〇	−	−
			server	任意の半角英数字を指定します。プロキシによるWebシナリオ実行では，browserNameがchromiumの場合は，browserType.launch()を実行する際に一度グローバルプロキシを設定し，Webシナリオ実行時にuse.proxyの値で上書きしてサイトにアクセスするという形式をとる必要があります。	〇	任意の半角英数字を指定します。	−
	proxy			ネットワークのプロキシ設定です。 browserNameがchromiumで，このパラメーターを使用する場合は，launchOptionsのproxy.serverを指定します。	〇	−	−
		server		リクエストに使用されるプロキシを指定します。 HTTPとSOCKSのプロキシがサポートされており，「httpまたはsocks`://myproxy.com:`ポート番号」の形式で指定します。 HTTPサーバがアプリケーション層で動作するのに対し，SOCKSサーバは，HTTPより下位のTCPあるいはUDPによる通信を中継します。TCP/UDPを利用して通信する上位層のプロトコルに制限はなく，HTTPプロキシより汎用的に利用できます。 HTTPかSOCKSかの指定を省略した場合はHTTPとして扱われます。	〇	リクエストに使用されるプロキシを，ドメイン全体の文字数が253文字以内となる半角英数字で指定します。	−
		bypass		プロキシを経由せず直接接続するドメインを指定します。	〇	プロキシ迂回用のドメインを253文字以内の半角英数字で指定します。 "localhost"，".com"，".domain.com"など，コンマで区切られた範囲で指定します。	−
		username		HTTPプロキシの認証要求時に使用するユーザー名を指定します。	〇	HTTPプロキシの認証要求時に使用するユーザー名を255文字以内の半角英数字で指定します。	−
		password		HTTPプロキシの認証要求時に使用するパスワードを指定します。	〇	HTTPプロキシの認証要求時に使用するパスワードを255文字以内の半角英数字で指定します。	−
	screenshot			テストのスクリーンショットを自動的に撮るかどうかを指定します。 ‘off’のとき各テスト後にスクリーンショットを撮影しません。‘on’のとき，各テスト後にスクリーンショットを撮影します。‘only-on-failure’のとき，失敗したテストの後にスクリーンショットを撮影します。	〇	次のどれかを指定できます。 on テスト実行後に常にスクリーンショットを撮る。 off テスト実行後に常にスクリーンショットを撮らない。 only-on-failure テスト失敗時にだけスクリーンショットを撮る。	off
	serviceWorkers			サイトにサービスワーカーの登録を許可するかどうかを指定します。	△	−	allow
	trace			各テスト実行でトレースを記録するかどうかを指定します。トレースの内容は，トレースビューアーでも確認できます。トレースの出力設定について，添付ファイル，スクリーンショット，スナップショット，ソースファイルの各項目ごとに，出力のオンオフを指定できます。このパラメーターでは，すべてのWebシナリオに関するトレース出力設定を行います。ただし，projectsパラメーター内にあるtraceで個別に値を指定しているWebシナリオに関しては，その設定内容でトレースが出力されます。そのため，projectsパラメーター内のtestMatchで指定しているWebシナリオに関するトレース出力設定を変更したい場合は，同じprojectsパラメーター内にあるtraceを編集する必要があります。初期状態では，すべてのWebシナリオがproject_1に含まれるように設定されています。また，「ログイン」に関するWebシナリオを実行した場合，トレースファイルにパスワードが平文で出力される点に留意する必要があります。トレースファイルの中でも，resourceフォルダ内に出力されるものについては，snapshotsの設定でオフにできますが，resourceフォルダ外のファイルは，traceの設定にかかわらず出力されるため，ユーザー責任での管理が必要となります。	〇	−	−
		mode		各テスト実行においてトレースを記録するかどうかを指定します。	〇	次のどれかを指定できます。 on トレースを常に記録する。 off トレースを常に記録しない。 retain-on-failure トレースを常に記録するが，テスト失敗時のものだけを残す。 retain-on-first-failure 各テストの最初の実行時にだけ記録し，リトライは記録しない。	on
		attachments		添付ファイルをトレースの記録に含めるかどうかを指定します。	△	−	false
		screenshots		スクリーンショットをトレースの記録に含めるかどうかを指定します。	〇	次のどちらかを指定できます。 true スクリーンショットを出力する。 false スクリーンショットを出力しない。	true
		snapshots		スナップショットをトレースの記録に含めるかどうかを指定します。	〇	次のどちらかを指定できます。 true スナップショットを出力する。 false スナップショットを出力しない。	false
		sources		使用したWebシナリオファイルをトレースの記録として保存するかどうかを指定します。	〇	次のどちらかを指定できます。 true Webシナリオファイルを出力する。 false Webシナリオファイルを出力しない。	false
	video			各テストで映像を記録するかどうかを指定します。	△	−	off
	actionTimeout			Playwrightの各アクションのタイムアウト時間をミリ秒で指定します。値が0の場合は，タイムアウトを実行しません。	△	−	0
	browserName			テストを実行するブラウザーの名前を指定します。	△	−	chromium
	bypassCSP			Content Security Policyを迂回するかどうかを指定します。	△	−	false
	channel			使用するブラウザーのチャネルを指定します。	△	−	chrome
	headless			ブラウザーをheadlessモードで起動するためのパラメーターです。	〇	デフォルトはtrueです。クライアント認証を使用する場合だけfalseを指定します。	true
	testIdAttribute			page.getByTestId()関数で使用されるカスタム属性を指定します。	△	−	data-testid
projects				複数のプロジェクトを同時にテスト実行する際のパラメーターです。テストごとに異なる設定を行いたい場合は，このパラメーターを使用します。	〇	−	−
	name			テスト名称を指定します。指定した名称がトレースファイルパス名に格納されます。各テストに固有の名前をつけたい場合は，このパラメーターを指定します。このパラメーター（projects内のname）とグローバルのnameを両方指定した場合は，projects内のnameパラメーターで上書きされます。このパラメーター（projects内のname）とグローバルのnameを両方省略した場合は，無名のテストとなり，トレースファイルパス名にテストの名前が使用されません。注　グローバルのnameは，すべてのテストにつける名称を指定するパラメーターです。	〇	各テストを識別するための名前を指定します。トレースファイルの格納先フォルダ名の文字数が，全角・半角文字で255文字以内となるように指定します。全角文字と半角文字は，それぞれ1文字として計算します。	project_1
	testMatch			テストファイル内で実行するファイルを文字列および正規表現で指定します。 projects内で行った設定は，testMatchパラメーターで指定したWebシナリオファイルにだけ適用されます。	〇	projectsに指定した設定内容に沿ってテストを実行したいWebシナリオファイルを指定します。文字列を指定する場合，255文字以内の全角または半角の英数字で指定します。ファイルパスを含めずにファイル名だけを指定する必要があります。	/.*/
	use			最上位の階層にあるuseパラメーターと同じ設定項目を扱えます。グローバルのuseは，すべてのテストの設定項目であるのに対し，projects内のuseは，テストごとに分けて設定を行えます。	〇	−	−
		trace		各テスト実行でトレースを記録するかどうかを指定します。トレースの内容は，トレースビューアーでも確認できます。トレースの出力設定について，添付ファイル，スクリーンショット，スナップショット，ソースファイルの各項目ごとに，出力のオンオフを指定できます。このパラメーターでは，testMatchで指定しているWebシナリオに関するトレース出力設定を行います。初期状態では，すべてのWebシナリオがproject_1に含まれるように設定されているため，testMatchがデフォルト値の状態でトレース出力設定を変更する場合は，このパラメーターを編集してください。また，「ログイン」に関するWebシナリオを実行した場合，トレースファイルにパスワードが平文で出力される点に留意する必要があります。トレースファイルの中でも，resourceフォルダ内に出力されるものについては，snapshotsの設定でオフにできますが，resourceフォルダ外のファイルは，traceの設定にかかわらず出力されるため，ユーザー責任での管理が必要となります。	〇	−	−
			mode	各テスト実行でトレースを記録するかどうかを指定します。	〇	次のどれかを指定できます。 on トレースを常に記録する。 off トレースを常に記録しない。 retain-on-failure トレースを常に記録するが，テスト失敗時のものだけを残す。 retain-on-first-failure 各テストの最初の実行時にだけ記録し，リトライは記録しない。	on
			attachments	添付ファイルをトレースの記録に含めるかどうかを指定します。	△	−	false
			screenshots	スクリーンショットをトレースの記録に含めるかどうかを指定します。	〇	次のどちらかを指定できます。 true スクリーンショットを出力する。 false スクリーンショットを出力しない。	true
			snapshots	スナップショットをトレースの記録に含めるかどうかを指定します。	〇	次のどちらかを指定できます。 true スナップショットを出力する。 false スナップショットを出力しない。	false
			sources	使用したWebシナリオファイルをトレースの記録として保存するかどうかを指定します。	〇	次のどちらかを指定できます。 true Webシナリオファイルを出力する。 false Webシナリオファイルを出力しない。	false

（凡例）: 〇：変更可　△：変更不可　−：該当なし

ページの先頭へ