Hamcrestテストを書く
Java用Axe DevTools for Webを使用したHamcrestマッチャーによるアクセシビリティテストの作成
前提条件
アクセシビリティテストを書いて結果を得るためには、Axe DevToolsでテストファイルをすでに作成し、選択したSelenium WebDriverを事前にインポートおよび初期化しておく必要があります。まだこの準備ができていない場合は、このガイドを読んで手順を確認してください。
Selenium WebDriverを使用して、hamcrestを通じたアクセシビリティテスト用の一連のマッチャーが提供されています。これらのマッチャーは、単体テストフレームワークやカスタムのキュウカンバーステップで使用することができます。
スキャン方法の選択
インポート文に見られるように、2つのアクセシビリティスキャン方法があります。最初のisAxeCleanは、違反が見つかった場合に例外をスローし、テストを停止します。2番目のisAuditedForAccessibilityは、スキャンされたページのアクセシビリティレベルに関係なく、テストを停止したり例外をスローしたりしません。
テストの作成
残りの例では、簡潔さのためにisAxeCleanメソッドが示されていますが、両方の方法が互換的に機能します。WebDriverとAxeDriverオブジェクトがインスタンス化および初期化されている場合、スキャンの作成はテストメソッドに次の2行のコードを追加するだけで簡単にできます。$URLをスキャンしたいページの希望するURLに置き換えてください。
webDriver.get("$URL");
assertThat(axedriver, isAxeClean());複数のページをテストする際には、ドライバーの新しいインスタンスを作成することなく、get、scan プロセスを繰り返すことができます。ページの異なる状態をスキャンするために、WebDriver API を使用してページを操作し、新しいスキャンを実行します。
追加の参考資料
ページのスキャン方法を変更するために利用可能ないくつかのチェーンメソッドがあります。これらのメソッドには、除外/包含句やスコープ設定、アクセシビリティ基準、アクセシビリティルール、およびアクセシビリティルールセットの変更が含まれます。簡潔にするために、すべてのチェーンメソッドはisAxeClean()と組み合わせられていますが、isAuditedForAccessibility()と互換性があります。
アクセシビリティ基準
Dequeは、チェーンメソッドaccording toを提供し、スキャンで使用されるアクセシビリティテスト標準を直接指定できます。
| タグ名 | アクセシビリティ標準 |
|---|---|
| wcag2a | WCAG 2.0 レベルA |
| wcag2aa | WCAG 2.0 レベルAA |
| wcag2aaa | WCAG 2.0 レベルAAA |
| wcag21a | WCAG 2.1 レベルA |
| wcag21aa | WCAG 2.1 レベルAA |
| wcag21aaa | WCAG 2.1 レベルAAA |
| wcag22a | WCAG 2.2 レベルA |
| wcag22aa | WCAG 2.2 レベルAA |
| wcag22aaa | WCAG 2.2 レベルAAA |
| section508 | セクション508 |
| EN-301-549 | EN 301 549 |
| RGAAv4 | RGAAバージョン4 |
| TTv5 | 信頼できるテスター v5 |
| ベストプラクティス | Dequeによって推奨されるベストプラクティス |
どの標準が自身に適しているか不明な場合は、どのルールがどの標準に関連しているかについてaxe-coreのドキュメントを読むか、Deque代表者またはヘルプデスクを介してお問い合わせください。各標準に適用されるルールの完全なリストについては、ルールの説明のこのページを参照してください。
単一の標準を使用するには、単にaccording toチェーンメソッドを追加し、目的の標準を渡します
assertThat(axedriver, isAxeClean().accordingTo("wcag2a"));2つ以上のテスト基準に対してスキャンするには、それらをすべて1回の呼び出しで渡します。accordingToを2回目に呼び出すと、追加されるのではなく、最初の呼び出しの基準が置き換えられます。
assertThat(axedriver, isAxeClean().accordingTo("wcag2a", "section508"));スコーピング
Deque は、スキャンのスコープ設定を支援するために2つのチェーンメソッドを提供しています。within()メソッドは、渡されたセレクターの範囲内のみをスキャンするようにスキャンを変更します。excluding()メソッドは反対の方法で機能します。それは、渡されたセレクター内のコンテンツを無視するようにスキャンを変更します。以下の例はすべてwithin()メソッドを示していますが、excluding()メソッドも同様に機能します。
もっとも簡単には、アサーションが1つのセレクターで変更されます
assertThat(axedriver, isAxeClean().within("#selector1")); 複合セレクターも可能です。以下の例では、セレクター1内のセレクター2を持つ要素のみがスキャンされます
assertThat(axedriver, isAxeClean().within("#selector1 .selector2"));複数のスコープをテストするために、複数の選択を行う方法は3つあります。これらの例では、セレクター1 および セレクター2内の要素が対象です。
assertThat(axedriver, isAxeClean().within("#selector1, .selector2"));
assertThat(axedriver, isAxeClean().within("#selector1", ".selector2"));
assertThat(axedriver, isAxeClean().within("#selector1").within(".selector2"));IFrame内をスコープ設定するには、IFrameセレクターを宣言する必要があります。IFrame内でスキャンするスコープは追加のパラメーターとして渡されます。
assertThat(axedriver, isAxeClean().within(new IFrameSelector("#frame1", "#selector1")));複数のIFrame内でのスコープ設定は、標準の複数選択と同じ方法で動作します。単にコンマで区切られた2つ以上のIFrameセレクターを作成します。
assertThat(axedriver, isAxeClean().within(new IFrameSelector("#frame1", "selector1"),
new IFrameSelector("#frame2", "#selector2")));入れ子になったIFrame内でスコープ設定することも可能です。この例は、2つ目のIFrame内にあるIFrameのセレクター1内でスキャンするスコープ設定を示しています。
assertThat(axedriver, isAxeClean().within(
new IFrameSelector("#frame1",
new IFrameSelector("#frame2", "#selector1"))));最後に、ページ内およびIFrame内に複数のスコープを設定することが可能です。これを実現するには、要素セレクターオブジェクトが必要です。
assertThat(axedriver, isAxeClean().within(
new ElementSelector("#selector1"),
new ElementSelector("#selector2"),
new IFrameSelector("#frame", "selector3")));ルールの選択
APIはスキャンで使用するルールを変更する機能も提供しています。これを行う方法は3つあり、スキャンの標準ルールセット外の追加ルールをチェックする、スキャンの標準ルールセット内のルールをチェックしない、明示的に指定されたルールのみをチェックする、があります。
これらのメソッドで使用可能な有効なルールタグと、それらが何をテストするかの完全なリストについては、ルールに関するドキュメントを参照してください。
追加のルールをチェックするには、checkingメソッドを使用します。単一の追加ルールをテストする場合は、ルールラベルをcheckingメソッドに渡すだけです
assertThat(axedriver, isAxeClean().checking("label"));複数の追加ルールをチェックするには、それらをすべて1回の呼び出しで渡します。checkingを2回目に呼び出すと、追加されるのではなく、最初の呼び出しのルールが置き換えられます。
assertThat(axedriver, isAxeClean().checking("label", "tabindex"));checkingメソッドは、ルール選択メソッドと組み合わせることもできます。
assertThat(axedriver, isAxeClean().accordingTo("wcag2a").checking("tabindex"));スキャンからルールを無視するオプションもあります。これは、skippingメソッドを使って実現可能です。このメソッドは、checkingメソッドと同様に動作しますが、ルールを追加するのではなく除外します。
assertThat(axedriver, isAxeClean().skipping("label"));複数のルールを省略するには、それらをすべて1回の呼び出しで渡します。checkingの場合と同様に、2回目のskipping呼び出しは最初のルールを置き換えます。
assertThat(axedriver, isAxeClean().skipping("label", "tabindex"));最後に、ルール選択メソッドと組み合わせて使用することもできます。
assertThat(axedriver, isAxeClean().accordingTo("wcag2a").skipping("label"));checkingとskippingは同じオプションを設定するので、連続して呼び出した場合には2つのうち最後の呼び出しだけが効果を発揮します。同じスキャンでこれらを組み合わせないでください。
最後の方法は特定のルールのみを希望する場合に使用されます。チェックのみの方法は、明示的に渡されたルールのみをチェックするようにスキャンを変更します。checkingOnlyとaccordingToは同じオプションを設定するので、2つのうち最後のものだけが効果を発揮します。単一のルールのみをチェックするには次のようにします。
assertThat(axedriver, isAxeClean().checkingOnly("label"));複数のルールをチェックするには、それらをすべて一度に渡します。2回目のcheckingOnly呼び出しは最初のルールを置き換えます。
assertThat(axedriver, isAxeClean().checkingOnly("label", "tabindex"));これらの方法に使用できる有効なルールタグの完全なリストと、それらが何をテストするかについては、ルールに関するドキュメントを読んでください。
違反の無視
スキャンを設定して特定の違反のインスタンスを無視することが可能です。このためには、無視する方法を使用します。その方法は、結果に表示される無視したい要素のtargetを、その要素が違反しているルールと組み合わせて渡します。対象はJavaがリストを出力する形式で記述されており、セレクタが角括弧内にあるようにします(例: "[.sidebar]")。ルールごとにignoring呼び出しが1回で十分です。マッチがそのルールのすべてのエントリを削除するため、同じルールに対して2回呼び出さないでください。もし両方の対象が失敗した要素と一致した場合、スキャンはIllegalStateExceptionをスローします。
assertThat(axedriver, isAxeClean()
.ignoring("[.sidebar]", "color-contrast")
.ignoring("[#branded-content]", "image-alt"));対象がそのルールに失敗する要素に一致した場合、そのルールのエントリ全体が他の要素の失敗を含めて違反から削除されます。APIリファレンスでignoring(String, String)を参照してください。
利用サービス
組織内のAxe DevToolsの利用トレンドに関する洞察を得る
デフォルトでは使用状況サービスが有効になっており、デフォルトのURLはhttps://usage.deque.comです。これを無効にするには、AXE_TRACK_USAGE環境変数をfalseに設定します。使用状況イベントがDequeに到達しない場合は、AXE_METRICS_URL環境変数を明示的に設定してください。
環境変数
これらの環境変数を使用して、使用サービスを設定し、報告されるイベントのプロパティを変更することができます。
| 名前 | タイプ | 上書き可能 | 説明 |
|---|---|---|---|
AXE_DISTINCT_ID |
文字列 | — | ログイン中のユーザーに対して同じままのUUID識別子(再生成されない限り)。Rubyでは、この変数はDEQUE_DISTINCT_IDと名付けられています。 |
AXE_INCLUDE_TEST_RESULTS |
ブール値 | — | 各イベントのtestResultsオブジェクトに完全なaxe-core結果を含めるには、trueに設定します(デフォルトはfalse)。CLIおよびNode.js APIのみでサポートされています。 |
AXE_METRICS_URL |
文字列 | — | REST使用エンドポイントのURL(デフォルトはhttps://usage.deque.com) |
AXE_TRACK_USAGE |
ブール値 | — | 使用サービスの報告を無効にするには、falseに設定します。報告はデフォルトで有効です。 |
AXE_ACTOR |
文字列 | — | テストを実行するのが人か自動化されたパイプラインかを上書きするには、humanまたはautomationに設定します。デフォルトでは、一般的なCI環境変数からautomationが検出されます。CLI、Node.js API、およびRuby APIのみがサポートしています。 |
AXE_APPLICATION |
文字列 | false | アクセシビリティエラーのチェックに使用されたアプリケーション |
AXE_DEV_INSTANCE |
ブール値 | true | このイベントがソフトウェア開発者の行動によるものかを示します。開発またはテスト中に記録されたイベントをマークし、後で削除するのに便利です。 |
AXE_DEPARTMENT |
文字列 | true | 組織内でのユーザーの部署 |
AXE_KEYCLOAK_ID |
文字列 | false | ユーザーのKeycloak ID |
AXE_LOGGED_IN |
ブール値 | false | テスト対象アプリケーションにユーザーがログインしているかどうかを記録します |
AXE_ORGANIZATION |
文字列 | true | ユーザーの組織。Axe Reportsに使用状況を表示するには、これを組織のIDに設定してください(取得するにはDequeに連絡してください)。 |
AXE_SESSION_ID |
文字列 | false | ユーザーのセッションを識別するUUID |
AXE_TEAMS |
文字列 | false | テストを実行するチームを、{ "id": "...", "name": "..." }オブジェクトのJSON配列として、またはそれを含むJSONファイルへのパスとして指定します。CLIの--set-teamsオプション、Node.js APIのsetTeamsメソッド、Ruby APIのfor_teams句またはteams設定プロパティに渡された値が優先されます。CLI、Node.js API、およびRuby APIのみがサポートしています。 |
AXE_USER_ID |
文字列 | false | 特定のユーザーのID。例えば、メールアドレス、名前、またはログインIDなどです。Axe Reportsはこの値を基にユニークユーザーをカウントします。 |
AXE_USER_JOB_ROLE |
文字列 | false | ユーザーの役割 |
AXE_USER_STATUS |
文字列 | false | ユーザーに紐づけたいステータス情報 |
次のステップ
Axe DevToolsのスキャン結果を今後の利用、例えばレポート作成を行うには、Axe DevTools Java Seleniumパッケージのドキュメントを参照してください
トラブルシューティング
アクセシビリティテストのセットアップに問題がある場合は、Dequeの担当者に直接連絡するか、当社のサポートデスクを通じて、またはメールを送信するでご連絡ください。皆様のアクセシビリティテスト活動の立ち上げをサポートできることを嬉しく思います。
