Axe DevTools for Web CLIの設定

この記事で説明されているフラグは、axe <url>、axe spec、axe bulk-specに利用可能です。これらのフラグのいずれかを設定すると、その値は設定ファイルに保存され、以降のすべての実行に対するデフォルトとなります。対応するフラグのない値のリセットを含む、設定をインタラクティブに表示または変更するには、axe config-seleniumを使用します。

ブラウザオプション

--accept-untrusted

ブラウザーに信頼されていないSSL証明書を受け入れるよう指示します。このオプションは、自己署名証明書を使用しているローカル開発サーバーや内部環境のテスト時に使用します。このフラグを通すと、acceptUntrustedCertificates: trueが設定ファイルに保存されます。それをfalseにリセットするには、axe config-seleniumを実行し、いいえの指示に従って回答するか、設定ファイルを直接編集してください。

axe <url> --accept-untrusted

--browser <name>

使用するブラウザーを指定します。対応するWebDriverがインストールされ、$PATH上で利用可能である必要があります。有効な値は: firefox（デフォルト）、chrome、safari、edge、ieです。

axe <url> --browser chrome

初回実行時にブラウザーの起動エラーが発生した場合、GeckoDriver（FirefoxのWebDriver）がインストールされていない可能性があります。その代わりに通常ほとんどのシステムで追加の設定なしで動作する--browser chromeを試してください。

このフラグを通すと、ブラウザー名が設定ファイルに保存されます。その後のすべての実行は、--browserなしでも保存されたブラウザーを使用します。保存されたブラウザーを変更するには、axe config-seleniumを実行し、プロンプトで異なるブラウザーを選択するか、設定ファイルを直接編集してください。

--headless

非表示モード（ウィンドウなし）でブラウザーを起動します。デフォルトはfalseです。

axe <url> --headless

--remote-server <url>

ローカルブラウザを起動する代わりに、リモートWebDriverサーバーに接続します。サーバーはSelenium Grid、BrowserStack、Sauce Labsのリモートなど、W3C WebDriver準拠のエンドポイントを公開している必要があります。

axe <url> --remote-server https://hub.browserstack.com/wd/hub

--window-size <width,height>

ブラウザのウィンドウサイズをピクセルで設定します。これはヘッドレスモードでのビューポートサイズも制御し、レスポンシブレイアウトのテストに便利です。

axe <url> --window-size 1280,900

タイミングオプション

--page-timeout <ms>

ページの読み込みが完了するのを待つ最大時間をミリ秒（ms）で指定します。デフォルトは60,000 ms（60秒）です。読み込みの遅いページや高レイテンシのネットワーク環境ではこれを増やしてください。

axe <url> --page-timeout 120000

--post-analyze-pause <ms>

分析完了後、次の操作までにワークフローを一旦停止させる時間をミリ秒で指定します。デフォルトは2,000 ms（2秒）です。

axe spec workflow.yml --post-analyze-pause 5000

--post-get-pause <ms>

ページの読み込み後、スキャンを開始する前に一旦停止させる時間をミリ秒で指定します。デフォルトは2,000 ms（2秒）です。動的コンテンツがスキャンを始める前にレンダリングされるためにより多くの時間を必要とする場合はこれを増やしてください。

axe <url> --post-get-pause 5000

--post-script-pause <ms>

ワークフロースクリプトの操作を実行した後、次の操作を続行する前に一旦停止させる時間をミリ秒で指定します。デフォルトは2,000 ms（2秒）です。

axe spec workflow.yml --post-script-pause 5000

--script-timeout <ms>

ワークフロースクリプトの実行完了を待つ最大時間をミリ秒で指定します。デフォルトは60,000 ms（60秒）です。

axe spec workflow.yml --script-timeout 120000

使用状況トラッキング

Axe DevTools CLIには、Dequeに匿名の使用データを送信する@deque/metrics-libraryが含まれています。このデータには、違反数、ルール数、axe-coreエンジンバージョンといった集計情報が含まれます。URLやページ内容、個人を特定する情報は含まれません。

識別IDは、ユーザーを特定せずに異なるCLI実行間でイベントを関連付けるために使用される設定ファイルに保存される値です。以下のオプションで追跡を変更または無効にできます。CLIを使用せずにこれらの値を設定するには、使用サービス環境変数を使用します。

--enable-tracking <state>

使用データをメトリクスライブラリに送信する機能を有効または無効にします。トラッキングはデフォルトで有効になっています。無効にするにはfalseを渡します。対応する環境変数はAXE_TRACK_USAGEです — 使用サービス環境変数を参照してください。

axe <url> --enable-tracking false

--set-distinct-id <id>

使用イベントを関連付けるために使用される固有のIDを変更します。このIDは設定ファイルに保存され、実行間で使用されます。対応する環境変数はAXE_DISTINCT_IDです — 使用サービス環境変数を参照してください。

axe <url> --set-distinct-id my-team-id

--set-tracking-url <url>

使用メトリクスが送信されるエンドポイントを変更します。組織がテレメトリを内部プロキシを通じてルーティングしている場合に使用します。対応する環境変数はAXE_METRICS_URLです — 使用サービス環境変数を参照してください。

axe <url> --set-tracking-url https://metrics.example.com/collect

使用サービス環境変数

CLIフラグに加えて、環境変数を使用して使用サービスを設定し、レポートされるイベントのプロパティを設定できます。上書き可能列は、環境変数の値がメトリクスライブラリを介してプログラム的にすでに設定された値を上書きすることができるかどうかを示します。ダッシュ（—）は、その変数には概念が適用されないことを示します。

ネットワークプロキシ

CLI の独自の外部リクエストは、標準のプロキシ環境変数に従います。これらのリクエストには、Axe レポートへのアップロード、Axe 開発者ハブへのアップロード、使用状況テレメトリがあります。

export HTTPS_PROXY=http://proxy.corp.example.com:3128
export HTTP_PROXY=http://proxy.corp.example.com:3128
export NO_PROXY=internal.example.com,.internal.example.net

HTTP_PROXY のみを設定した場合、CLI は https: リクエストにもそれを使用するため、単一のプロキシにはその1つの変数のみが必要です。

これらの変数は CLI の独自のリクエストのみを管理します。スキャンが実行されている間にブラウザのページロードをプロキシすることはありません。ブラウザのトラフィックをプロキシ経由でルーティングするには、代わりに --remote-proxy を使用してください。

プロキシからホストを除外する

NO_PROXY は、カンマまたはスペースで区切られたホスト名のリストを受け入れ、それぞれにオプションの :port が付いています。名前は正確に （internal.example.com) 、またはサフィックスとして .example.net や *.example.net の形で書かれ、そのドメインおよびその下にあるすべてを除外します。NO_PROXY を * に設定すると、プロキシが完全に無効になります。

この文法から外れるエントリは、エラーとして報告されることなく無視されるため、知っておくべき2つの制限があります。

• CIDR 範囲はサポートされていません。 NO_PROXY=10.0.0.0/8 は決して何にも一致せず、それらのアドレスへのトラフィックは依然としてプロキシに送信されます。
• ループバックアドレスはデフォルトでは免除されていません。 ローカルマシン上のセルフホストのコレクタまたはレポートホストに到達するためには、NO_PROXY=localhost,127.0.0.1 のように明示的に名前を付けてください。

TLS をインターセプトするプロキシ

プロキシがプライベート証明書機関で TLS を終了する場合、Node.js をその証明書機関バンドルに向けます。

export NODE_EXTRA_CA_CERTS=/etc/ssl/certs/corp-ca.pem

それがないと、CLI は証明書の検証エラーで停止します。

axe config-selenium

axe config-seleniumを使用してデフォルトをインタラクティブに設定します。ブラウザー、タイムアウト、その他の設定の値を入力するように求められます。あなたの回答は設定ファイルに保存され、以降のすべてのCLI実行のデフォルトとなります。

$ axe config-selenium
? Choose browser for running automated tests: (Use arrow keys)
? Choose browser for running automated tests: chrome
? Enter a value for pageLoadTimeout: 60000
? Enter a value for setScriptTimeout: 60000
? Accept untrusted ssl certs: Yes
? Enter a value for postGetPause: 2000
? Enter a value for postScriptPause: 2000
? Enter a value for postAnalysisPause: 2000
? Launch browser in headless mode: No

Results saved to ~/.config/preferences/com.deque.axe.devtools.cli.pref

インタラクティブプロンプトに入らずに現在の保存設定を表示するには、--showフラグを使用します:

axe config-selenium --show

設定ファイル

すべての設定可能なデフォルトは、以下のJSONファイルに保存されます：

~/.config/preferences/com.deque.axe.devtools.cli.pref

典型的なファイルはこのようなものです：

{
  "selenium": {
    "acceptUntrustedCertificates": false,
    "browser": "firefox",
    "headless": false,
    "pageLoadTimeout": 60000,
    "postAnalysisPause": 2000,
    "postGetPause": 2000,
    "postScriptPause": 2000,
    "setScriptTimeout": 60000
  }
}

axe config-seleniumを使用したり、コマンドラインでフラグを渡したりする代わりに、このファイルを直接編集することができます。これは、acceptUntrustedCertificatesのようなブール値をインタラクティブプロンプトを実行せずにリセットするのに便利です。