HamcrestのAPIリファレンス
Axe DevTools for Web Java Hamcrest matcherタイプのAPIリファレンス
hamcrestパッケージによって提供されるタイプのリファレンス。
IsAccessibleとIsAuditedForAccessibilityクラスは主要な機能を提供します。これらのインスタンスを取得するには、静的ファクトリーメソッドisAxeClean()またはisAuditedForAccessibility()を使用し、その後にAxeDevtoolsMatcherメソッドをチェーンしてチェックを設定します。
このページの例では、webDriverがSeleniumのWebDriverで、driverがそれをラッピングするAxeDriver、およびこれらの静的インポートを前提としています。セレクタークラスはcom.deque.html.axedevtools.matchers.selectorsから、AxeReportingOptionsはcom.deque.html.axedevtools.selenium.reporterから取得されます。
import static org.hamcrest.MatcherAssert.assertThat;
import static com.deque.html.axedevtools.matchers.IsAccessible.isAxeClean;
import static com.deque.html.axedevtools.matchers.IsAuditedForAccessibility.isAuditedForAccessibility;com.deque.html.axedevtools.matchers.AxeDevtoolsMatcher
Axe DevToolsマッチャーの基本クラスです。これはHamcrestのTypeSafeMatcher<AxeDriver>を拡張しており、AxeDriverに対してマッチします。これを直接作成することはせず、IsAccessibleまたはIsAuditedForAccessibilityを使用してください。それらは以下のすべてのメソッドを継承しています。
各設定メソッドは同じマッチャーを返すため、呼び出しをチェーンすることができます。スキャン自体はassertThatがマッチャーを評価するときに実行されます。内部的には、各マッチャーがAxeSeleniumスキャンを実行するため、オプションの組み合わせに関するルールはここでも適用されます。
within(String...)
Limits the scan to the elements matched by the given CSS selectors, and their descendants. Each selector adds a separate area to the scan, so within("#header", "#footer") tests both, the same as calling within once for each. This differs from AxeSelenium.include(Object...), where several arguments form one path.
public AxeDevtoolsMatcher within(String... cssSelectors);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
cssSelectors |
String... |
1つ以上のCSSセレクタで、それぞれがトップレベルのドキュメントにあります。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().within("#header", "#footer"));within(Selector...)
スキャンをSelectorオブジェクトによって記述された領域に限定します。IFrameSelectorと共に使用して、iFrame内部の要素をテストします。各セレクターはスキャンに別々の領域を追加します。
public AxeDevtoolsMatcher within(Selector... selectors);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
selectors |
Selector... |
1つ以上のElementSelectorまたはIFrameSelectorオブジェクト。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
// Test the form inside the #payment-frame iframe
assertThat(driver, isAxeClean().within(new IFrameSelector("#payment-frame", "form")));within(Object...)
他のセレクタオブジェクト、特にFromFramesとFromShadowDomによって記述された領域にスキャンを限定します。シャドウDOMツリー内の要素をテストするのに使用します。Selectorオブジェクトは表現できません。各引数はスキャンに別々の領域を追加します。
public AxeDevtoolsMatcher within(Object... selectors);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
selectors |
Object... |
1つ以上のセレクターで、それぞれがCSSセレクター文字列、文字列のリスト、FromFramesセレクター、またはFromShadowDomセレクターです。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
// Test the #search form inside the shadow root attached to .app-header
assertThat(driver, isAxeClean().within(new FromShadowDom(".app-header", "form#search")));excluding(String...)
指定されたCSSセレクターによって一致する要素とその子孫をスキャンから除外します。各セレクターは別々の領域を除外します。除外はwithin呼び出しの上で適用されるため、特定の部分を除いて領域をテストできます。
public AxeDevtoolsMatcher excluding(String... cssSelectors);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
cssSelectors |
String... |
1つ以上のCSSセレクタで、それぞれがトップレベルのドキュメントにあります。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
// Test main, but skip the .cookie-banner and .ad-slot inside it
assertThat(driver, isAxeClean().within("main").excluding(".cookie-banner", ".ad-slot"));excluding(Selector...)
Selectorオブジェクトによって記述された領域をスキャンから除外します。例えば、iFrame内部の要素です。各セレクターは別々の領域を除外します。
public AxeDevtoolsMatcher excluding(Selector... selectors);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
selectors |
Selector... |
1つ以上のElementSelectorまたはIFrameSelectorオブジェクト。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
// Skip the third-party ad inside the #ad-frame iframe
assertThat(driver, isAxeClean().excluding(new IFrameSelector("#ad-frame", ".ad")));excluding(Object...)
他のセレクタオブジェクト、特にFromFramesとFromShadowDomによって記述された領域をスキャンから除外します。各引数が別々の領域を除外します。
public AxeDevtoolsMatcher excluding(Object... selectors);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
selectors |
Object... |
1つ以上のセレクターで、それぞれがCSSセレクター文字列、文字列のリスト、FromFramesセレクター、またはFromShadowDomセレクターです。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
// Skip the chat widget inside the shadow root attached to support-chat
assertThat(driver, isAxeClean().excluding(new FromShadowDom("support-chat", ".widget")));accordingTo(String...)
少なくとも1つの指定されたタグを持つルールのみを実行します。例えばwcag2aやbest-practiceなどです。
accordingToとcheckingOnlyは同じオプションを設定するため、2つの呼び出しの最後のものだけが有効になります。2回目のaccordingTo呼び出しも最初からタグを置き換えるため、タグはすべて1回の呼び出しで渡してください。
public AxeDevtoolsMatcher accordingTo(String... tags);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
tags |
String... |
1つ以上のaxe-coreタグ。それぞれのルールのタグについてはルールの説明をご覧ください。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().accordingTo("wcag2a", "wcag2aa"));checkingOnly(String...)
指定されたルールのみを実行し、他のルールは実行しません。
checkingOnlyとaccordingToは同じオプションを設定するため、2つの呼び出しの最後のものだけが有効になります。2回目のcheckingOnly呼び出しも最初からルールを置き換えるため、すべてのルールIDを1回の呼び出しで渡してください。
public AxeDevtoolsMatcher checkingOnly(String... rules);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
rules |
String... |
1つ以上のaxe-coreルールID。ルールの説明をご覧ください。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().checkingOnly("label", "color-contrast"));checking(String...)
ルールセットまたはaccordingToによって既に選択されているルールに加えて、指定されたルールを有効にします。
checkingとskippingは同じオプションを設定するため、2つの呼び出しの最後のものだけが有効になります。2回目のchecking呼び出しも最初からルールを置き換えるため、すべてのルールIDを1回の呼び出しで渡してください。また、同じチェック内でcheckingとskippingを組み合わせないでください。
public AxeDevtoolsMatcher checking(String... rules);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
rules |
String... |
1つ以上のaxe-coreルールID。ルールの説明をご覧ください。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
// WCAG 2.0 Level A rules, plus the tabindex best-practice rule
assertThat(driver, isAxeClean().accordingTo("wcag2a").checking("tabindex"));skipping(String...)
指定されたルールを無効にし、選択されたルールセットやタグの残りを維持します。
skippingとcheckingは同じオプションを設定するため、2つの呼び出しの最後のものだけが有効になります。2回目のskipping呼び出しも最初からルールを置き換えるため、すべてのルールIDを1回の呼び出しで渡してください。また、同じチェック内でskippingとcheckingを組み合わせないでください。
public AxeDevtoolsMatcher skipping(String... rules);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
rules |
String... |
1つ以上のaxe-coreルールID。ルールの説明をご覧ください。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().skipping("color-contrast", "image-alt"));ignoring(String, String)
指定された要素でルールが失敗した場合、その要素に適用されたルールの違反を結果から削除し、アサーションが失敗しないようにします。セレクターは、結果内の要素のtargetと正確に一致している必要があります。形式は"[#sidebar]"です。
フィルタリングはルール全体に対して機能します。ルールに失敗した要素がセレクターに一致する場合、そのルールのエントリー全体が削除され、他の要素での失敗も含まれます。1ルールあたり1回の呼び出しで十分です。同じルールに対して2回の呼び出しが両方とも一致する場合、IllegalStateExceptionがスローされます。詳細はAxeSelenium.ignoring(String, String)をご覧ください。
public AxeDevtoolsMatcher ignoring(String selector, String ruleId);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
selector |
String |
結果内に表示される要素のtarget。 |
ruleId |
String |
無視するルールのID。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().ignoring("[#sidebar]", "color-contrast"));forConfig(URL)
監査スイート(JSONルール設定ファイル)をURLで選択します。AxeSelenium.forConfig(URL)と同様に、これによりグローバル監査スイートが設定されるため、その後のチェックにも適用されます。
public AxeDevtoolsMatcher forConfig(URL auditPath);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
auditPath |
URL |
監査スイートファイルのURL。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
URL auditSuite = getClass().getResource("/config/my-audit-suite.json");
assertThat(driver, isAxeClean().forConfig(auditSuite));forConfig(String)
監査スイートをファイルシステム上のパスで選択します。forConfig(URL)と同様に、グローバル監査スイートが設定されます。
public AxeDevtoolsMatcher forConfig(String auditPath) throws MalformedURLException;パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
auditPath |
String |
監査スイートファイルのファイルシステムパス。 |
戻り値
メソッドチェーン用のこのマッチャー。
スローされます
パスをURLに変換できない場合はMalformedURLException。
例
@Test
public void matchesAuditSuite() throws MalformedURLException {
assertThat(driver, isAxeClean().forConfig("/opt/axe/my-audit-suite.json"));
}forRuleset(String)
ルールセットを選択してチェックを行います。例えば、wcag2.2や508があり、ベストプラクティスルールはオフになっています。nullを渡すとデフォルト、wcag2.1が選択されます。AxeSelenium.forRuleset(String)と同様に、これはグローバルルールセットを設定するため、その後のチェックにも適用されます。ルールセットIDについてはAxeConfiguration.forRuleset(String)をご覧ください。
マッチャーには、ルールセットと共にベストプラクティスルールをオンにする方法がありません。それを行うには、チェックの前にAxeConfiguration.configure().forRuleset(rulesetId, true)を呼び出し、マッチャーのforRulesetも呼び出してベストプラクティスルールをオフにしないでください。
public AxeDevtoolsMatcher forRuleset(String rulesetId);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
rulesetId |
String |
ルールセットのID。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().forRuleset("wcag2.2"));logResults(AxeReportingOptions)
このチェックのレポートを書き出します。違反をリストアップした.logファイルと、完全な結果を含む.jsonファイルです。ファイル名と場所はreportingOptionsから取得されます。AxeReportingOptionsをご覧ください。isAxeClean()では、logResultsを呼び出さない限り、レポートは書き出されません。
reportingOptionsにライン番号が設定されていない場合、Axe DevToolsはlogResultsを呼び出したテストの行を記録します。
public AxeDevtoolsMatcher logResults(AxeReportingOptions reportingOptions);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
reportingOptions |
AxeReportingOptions |
レポートの出力先と、その中でテストをどのように記述するか。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("checkout")
.uiState("page-loaded");
assertThat(driver, isAxeClean().logResults(options));setReportingOptions(AxeReportingOptions)
Replaces the reporting options that isAuditedForAccessibility() uses when you don't call logResults. It has no effect on isAxeClean(), which only writes a report through logResults. The options you pass replace the defaults entirely: any value you don't set falls back to AxeConfiguration (reports go to axe-reports unless you set outputDirectory), and you must set uiState.
public AxeDevtoolsMatcher setReportingOptions(AxeReportingOptions reportingOptions);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
reportingOptions |
AxeReportingOptions |
使用するレポートオプション。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAuditedForAccessibility()
.setReportingOptions(new AxeReportingOptions().testSuiteName("nightly").uiState("home")));setTimeout(int)
チェックがタイムアウトで失敗するまでに、axe-coreがページを分析する秒数を設定します。デフォルトは30秒です。
public AxeDevtoolsMatcher setTimeout(int timeout);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
timeout |
int |
タイムアウト(秒単位)。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().setTimeout(120));enableAnalytics(boolean)
このチェック用に使用状況サービスをオンまたはオフにします。使用状況サービスはデフォルトでオンです。AXE_TRACK_USAGE環境変数が設定されている場合、これが優先され、このメソッドは効果を持ちません。trueはサービスをオンにし、その他の値はサービスをオフにします。
public AxeDevtoolsMatcher enableAnalytics(boolean state);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
state |
boolean |
使用状況データを送信するにはtrue、送信を停止するにはfalseにします。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().enableAnalytics(false));trackingEnabled()
このチェックが使用状況データを送信しているかどうかを報告します。
public boolean trackingEnabled();戻り値
使用状況サービスがオンの場合はtrueです。
setAnalyticsUrl(String)
使用状況データが送信されるURLを設定します。デフォルトはAXE_METRICS_URL環境変数で、設定されていない場合はhttps://usage.deque.comです。AXE_METRICS_URLが設定されている場合、このメソッドは効果を持ちません。
public AxeDevtoolsMatcher setAnalyticsUrl(String url);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
url |
String |
使用状況サービスのURL。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().setAnalyticsUrl("https://usage.example.com"));setAnalyticsDisinctId(String)
使用状況データと共に送信される固有のIDを設定します。メソッド名はAPIではDisinctと綴られているので、示された通りにタイプしてください。このIDは~/.deque/distinct_idに保存されるため、同じマシンで後に実行しても引き続き使用されます。IDがAXE_DISTINCT_ID環境変数から来ている場合、このメソッドは効果を持ちません。
public AxeDevtoolsMatcher setAnalyticsDisinctId(String id);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
id |
String |
固有のID。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean().setAnalyticsDisinctId("build-agent-7"));setAnalyticsComponentName(String)
使用状況データと共に送信されるプロジェクト名を設定します。これにより、以前のsetAnalyticsUrlとenableAnalyticsの呼び出しがデフォルトにリセットされるため、これらのメソッドの前に呼び出してください。setAnalyticsDisinctIdで設定された固有のIDは保持されます。
public AxeDevtoolsMatcher setAnalyticsComponentName(String name);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
name |
String |
プロジェクト名。 |
戻り値
メソッドチェーン用のこのマッチャー。
例
assertThat(driver, isAxeClean()
.setAnalyticsComponentName("storefront-tests")
.setAnalyticsDisinctId("build-agent-7"));com.deque.html.axedevtools.matchers.IsAccessible
ページにアクセシビリティ違反がある場合、アサーションに失敗するマッチャー。AxeDevtoolsMatcherを拡張しているため、上記のすべてのメソッドをチェーンしてスコープ、ルール、監査スイート、レポートを設定できます。
アサーションが失敗した場合、失敗メッセージは各違反、影響を受けた要素、およびそれを修正する方法を.logレポートと同じ形式で一覧表示します。axe-coreが結果ではなくエラーを返した場合、チェックはアサーションに失敗するのではなくAxeRuntimeExceptionをスローします。
assertThat(driver, isAxeClean()
.within("#header")
.within("#footer")
.excluding(".graphics")
.accordingTo("wcag2a", "wcag2aa"));isAxeClean()
Creates an IsAccessible matcher. This static method is the only way to get one. With no further configuration, it checks the whole page against the global ruleset, which defaults to wcag2.1, and writes no report.
public static IsAccessible isAxeClean();戻り値
新しいIsAccessibleマッチャー。
例
@Test
public void homePageIsAccessible() {
webDriver.get("https://example.com");
assertThat(driver, isAxeClean());
}com.deque.html.axedevtools.matchers.IsAuditedForAccessibility
ページをスキャンしてレポートを書きますが、違反のためにアサーションに失敗することは決してないマッチャー。axe-coreのエラーはAxeRuntimeExceptionをスローしますが、isAxeClean()と同様に。モニタリングのために結果を収集してビルドを壊さないように使用してください。レポートからのリグレッションを追跡する必要があります。AxeDevtoolsMatcherを拡張しているため、上記のすべてのメソッドをチェーンして使用できます。
logResultsを呼び出さない限り、レポートはtarget/axe-report/accessibility-check.logとtarget/axe-report/accessibility-check.jsonに書かれます。これらのデフォルトを変更するにはsetReportingOptionsを使用します。それぞれのチェックは同じパスで以前のレポートを上書きするので、setReportingOptionsまたはlogResultsを通じて各チェックのテストスイート名やUI状態を設定するか、useUniqueFilenameをオンにしてください。
assertThat(driver, isAuditedForAccessibility()
.within("#header")
.within("#footer")
.excluding(".graphics")
.accordingTo("wcag2a", "wcag2aa"));isAuditedForAccessibility()
IsAuditedForAccessibilityマッチャーを作成します。この静的メソッドはそれを取得する唯一の方法です。
public static IsAuditedForAccessibility isAuditedForAccessibility();戻り値
新しいIsAuditedForAccessibilityマッチャー。
例
@Test
public void auditCheckoutPage() {
webDriver.get("https://example.com/checkout");
assertThat(driver, isAuditedForAccessibility()
.logResults(new AxeReportingOptions().testSuiteName("checkout").uiState("loaded")));
}com.deque.html.axedevtools.matchers.selectors.Selector
ElementSelectorとIFrameSelectorによって実装されるインターフェース。within(Selector...)またはexcluding(Selector...)にセレクターを渡します。
toList()
セレクターをCSSセレクターのリストとして返します:各iFrameレベルごとに1つ、その後に要素のセレクター。どちらの実装もそれを提供します。マッチャーはそれを呼び出してくれるので、テストでは呼び出す必要はありません。
List<String> toList();戻り値
List\<String>としてのCSSセレクター。
com.deque.html.axedevtools.matchers.selectors.ElementSelector
現在のドキュメント内の要素のためのSelector。単独ではCSSセレクター文字列をwithinまたはexcludingに渡すことと同等で、その主な使用法はIFrameSelectorの最内部分としてです。
ElementSelector(String)
CSSセレクターと一致する要素のためのセレクターを作成します。
public ElementSelector(String cssSelector);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
cssSelector |
String |
CSSセレクター。 |
例
// The form inside #inner-frame, which is inside #outer-frame
Selector form = new IFrameSelector("#outer-frame",
new IFrameSelector("#inner-frame", new ElementSelector("form")));com.deque.html.axedevtools.matchers.selectors.IFrameSelector
iFrame内の要素のためのSelector。ネストされたiFrame内の要素に到達するためにもう一つのIFrameSelectorをネストさせます。
IFrameSelector(String, String)
1つのiFrame内の要素のためのセレクターを作成します。
public IFrameSelector(String frameSelector, String cssSelector);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
frameSelector |
String |
ページ上のiFrame要素のためのCSSセレクター。 |
cssSelector |
String |
iFrame内でテストする要素のためのCSSセレクター。 |
例
assertThat(driver, isAxeClean().within(new IFrameSelector("#payment-frame", "form")));IFrameSelector(String, Selector)
iFrame内の要素のためのセレクターを作成し、その要素が他のSelectorによって記述されています。もう一つのIFrameSelectorを渡して1つのiFrame深く、またはElementSelectorを渡します。
public IFrameSelector(String frameSelector, Selector selector);パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
frameSelector |
String |
ページ上のiFrame要素のためのCSSセレクター。 |
selector |
Selector |
ネストされたiFrameのためのIFrameSelector、またはテストする要素のためのElementSelector。 |
例
// The form inside #inner-frame, which is inside #outer-frame
assertThat(driver, isAxeClean().within(
new IFrameSelector("#outer-frame", new IFrameSelector("#inner-frame", "form"))));