SeleniumのAPIリファレンス

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Axe DevTools for Web JavaにおけるAxeSelenium、AxeConfiguration、および関連するセレクター、レポーティング、結果のクラスのAPIリファレンス

Not for use with personal data

このドキュメントは、AxeSeleniumおよびAxeConfigurationクラス、そしてそれらが使用するセレクター、レポーティング、結果のタイプに関するリファレンスです。AxeSeleniumクラスがほとんどのユースケースをカバーし、AxeConfigurationが残りをカバーするはずです。

このページの例では、webDriverがあなたのSeleniumWebDriverであり、driverがそれをラップするAxeDriverであることを想定しています。

com.deque.html.axedevtools.selenium.AxeSelenium

アクセシビリティスキャンを設定し、実行します。各設定メソッドは同じAxeSeleniumインスタンスを返すため、連鎖して呼び出すことができ、run(AxeDriver)がスキャンを実行します。

Results results = new AxeSelenium()
    .include(".my-css-class")
    .skipping("aria-required-parent")
    .run(driver);

AxeSelenium()

グローバルなAxeConfiguration設定(ルールセット、監査スイート、レポート出力ディレクトリなど)を使用するAxeSeleniumスキャンを作成します。基礎となるAxeBuilderをカスタマイズする必要がない限り、このコンストラクターを使用してください。

public AxeSelenium();

例

Results results = new AxeSelenium().run(driver);

AxeSelenium(AxeBuilder)

Creates an AxeSelenium scan that runs through the AxeBuilder you supply, from the axe-core Selenium integration (com.deque.html.axecore.selenium.AxeBuilder). Use it to reach AxeBuilder options that AxeSelenium doesn't expose, such as legacy mode. The global AxeConfiguration settings still apply.

public AxeSelenium(AxeBuilder axeBuilder);

パラメータ

名前 タイプ 説明
axeBuilder AxeBuilder ページにaxe-coreを注入し、実行するために使用されるビルダー。

例

import com.deque.html.axecore.selenium.AxeBuilder;

Results results = new AxeSelenium(new AxeBuilder().setLegacyMode())
    .run(driver);

run(AxeDriver)

現在pageが表示しているページを、このAxeSeleniumで設定されたすべてのオプションを使用してスキャンし、結果を返します。無視された違反(AxeSelenium.ignoring(String, String)を参照)は結果から削除され、logResultsが呼び出された場合、runが戻る前にレポートファイルが書き込まれます。

スキャン中にaxe-coreがエラーを報告した場合、runは結果を返す代わりにそれをスローします。

public Results run(AxeDriver page);

パラメータ

名前 タイプ 説明
page AxeDriver スキャンするページ。

戻り値

違反、合格、不完全、及び不適用な結果を保持するResultsオブジェクト(com.deque.html.axecore.results.Results)。

スロー

  • axe-coreが結果の代わりにエラーを返したときのAxeRuntimeException(com.deque.html.axecore.results.AxeRuntimeException)。
  • スキャン自体が失敗した場合のRuntimeException。例えば、axe.finishRunが失敗した場合やドライバーがウィンドウ間を切り替えられない場合です。

例

webDriver.get("https://example.com");
Results results = new AxeSelenium().run(driver);

if (!results.violationFree()) {
    System.out.println(results.getViolations().size() + " rules have violations");
}

runCommand()

レガシーモードでブラウザでAxeSeleniumが実行する、一般的なaxe.runスクリプトを返します。このスクリプトには、このスキャンのコンテキストやオプションは含まれず、axe-core 4.3以降(デフォルト、非レガシーモード)では、異なる一連の呼び出しを通じてスキャンが実行されます。AxeSeleniumはこのスクリプトをレポーターに渡すため、主にAxeDevtoolsReporter.generateReportで独自のレポートテキストを作成する際に便利です。

public String runCommand();

戻り値

スクリプト、Stringとして。

include(String)

CSSセレクターで一致する要素とその子孫に対してスキャンを制限します。各呼び出しがスキャンに別のエリアを追加しますので、ページの無関係な部分をテストするには、それぞれに対してincludeを一度呼び出してください。単一のカンマ区切りセレクター(".sidebar, .some-class")も機能します。なぜならそれがそのままブラウザに渡されるからです。

public AxeSelenium include(String cssSelector);

パラメータ

名前 タイプ 説明
cssSelector String 有効なCSSセレクター。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Test .sidebar and .some-class, which are both in the top-level document
Results results = new AxeSelenium()
    .include(".sidebar")
    .include(".some-class")
    .run(driver);

include(List\<String>)

1つまたは複数のネストされたiFrame内の要素に対してスキャンを制限します。最後の文字列以外は1つのiFrameネストレベルに一致し、最後のものが最も内側のiFrame内のテスト対象要素に一致します。このリストは1つのパスを示し、複数のセレクターを示すものではありません。

include(String...)のオーバーロードはないため、includeに複数の文字列を渡すと単一のiFrameセレクターが作成され、別々のインクルードにはなりません: include("#parent-iframe", "#html")はinclude(Object...)に解決され、以下の例と同じ意味を持ちます。

include(FromFrames)は同じことをより明確に表現し、新しいテストには推奨される形式です。

public AxeSelenium include(List<String> selector);

パラメータ

名前 タイプ 説明
selector List\<String> iFrameネストの各レベルに対する1つのCSSセレクター、その後に最も内側のiFrame内の要素に対するCSSセレクター。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Test #html inside the iframe matched by #parent-iframe
Results results = new AxeSelenium()
    .include(Arrays.asList("#parent-iframe", "#html"))
    .run(driver);

include(FromFrames)

明示的なFromFramesセレクターを使用して、1つまたは複数のネストされたiFrame内の要素に対してスキャンを制限します。

public AxeSelenium include(FromFrames fromFrames);

パラメータ

名前 タイプ 説明
fromFrames FromFrames 最後以外の各セレクターは、1つのiFrameネストレベルに一致し、最後のものが最も内側のiFrame内のテスト対象要素に一致します。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Test the form inside the #payment-frame iframe
Results results = new AxeSelenium()
    .include(new FromFrames("#payment-frame", "form"))
    .run(driver);

include(FromShadowDom)

明示的なFromShadowDomセレクターを使用して、1つまたは複数のネストされたシャドウDOMツリー内の要素に対してスキャンを制限します。

public AxeSelenium include(FromShadowDom fromShadowDom);

パラメータ

名前 タイプ 説明
fromShadowDom FromShadowDom 最後以外の各セレクターは、シャドウホストに一致し、最後が最も内側のシャドウルート内のテスト対象要素に一致します。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Test the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
    .include(new FromShadowDom(".app-header", "form#search"))
    .run(driver);

include(Object)

単一のオブジェクトとして提供されたセレクターを使用してスキャンを制限します。引数の静的型が上記の型のいずれでもない場合、Javaはこのオーバーロードを選択します。例えばObjectとして宣言された変数の場合です。型指定されたオーバーロードを優先してください。

public AxeSelenium include(Object selector);

パラメータ

名前 タイプ 説明
selector Object CSSセレクターの文字列、文字列のリスト、FromFramesセレクター、またはFromShadowDomセレクター。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// The selector's type is chosen at runtime, so it's held as Object
Object scope = useFrame ? new FromFrames("#frame", "main") : "main";
Results results = new AxeSelenium()
    .include(scope)
    .run(driver);

include(Object...)

プレーンなCSSセレクターとFromFramesまたはFromShadowDomセレクターを混ぜて、他のオーバーロードでは表現できないケースに対してセレクターを使用してスキャンを制限します。全ての引数が一つの要素への単一のパスを形成し、それらは個別のインクルードではありません。

このオーバーロードは、呼び出しが複数の引数を渡すときに選択されます。単一のFromFramesまたはFromShadowDomを渡すと、代わりにinclude(FromFrames)またはinclude(FromShadowDom)が選択されます。

シャドウルート内にあるiFrameに到達するには、FromShadowDomセレクターをFromFramesセレクターの中にネストします。その逆は表現できません。なぜならFromShadowDomは文字列しか受け付けないからです。

public AxeSelenium include(Object... selector);

パラメータ

名前 タイプ 説明
selector Object... テスト対象の要素への単一パスを形成する、CSSセレクターとセレクターオブジェクトの混合セット。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Test .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
    .include("#frame", new FromShadowDom("#host", ".target"))
    .run(driver);

exclude(String)

CSSセレクターで一致する要素とその子孫をスキャンから除外します。各呼び出しが別のエリアを除外するので、ページの無関係な部分をスキップするには、それぞれに対してexcludeを1回呼び出してください。除外はどのようなinclude呼び出しにも適用されます、これにより一部を除いて領域をテストできます。

public AxeSelenium exclude(String cssSelector);

パラメータ

名前 タイプ 説明
cssSelector String 有効なCSSセレクター。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Test main, but skip the .cookie-banner and .ad-slot inside it
Results results = new AxeSelenium()
    .include("main")
    .exclude(".cookie-banner")
    .exclude(".ad-slot")
    .run(driver);

exclude(List\<String>)

Removes an element inside one or more nested iFrames from the scan. Every string but the last matches one level of iFrame nesting; the last matches the element to skip inside the innermost iFrame. The list describes one path, not several selectors.

exclude(String...)のオーバーロードはないため、excludeに複数の文字列を渡すと単一のiFrameセレクターが作成され、別々の除外にはなりません: exclude(".iframe1", ".third-party-ad")はexclude(Object...)に解決され、以下の例と同じ意味を持ちます。

exclude(FromFrames)は同じことをより明確に表現し、新しいテストには推奨される形式です。

public AxeSelenium exclude(List<String> selector);

パラメータ

名前 タイプ 説明
selector List\<String> iFrameネストの各レベルに対する1つのCSSセレクター、その後に最も内側のiFrame内の要素に対するCSSセレクター。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Skip .third-party-ad inside the iframe matched by .iframe1
Results results = new AxeSelenium()
    .exclude(Arrays.asList(".iframe1", ".third-party-ad"))
    .run(driver);

exclude(FromFrames)

明示的なFromFramesセレクターを使用して、1つまたは複数のネストされたiFrame内の要素をスキャンから除外します。

public AxeSelenium exclude(FromFrames fromFrames);

パラメータ

名前 タイプ 説明
fromFrames FromFrames 最後以外の各セレクターは1つのiFrameネストレベルに一致し、最後のものが最も内側のiFrame内で除外する要素に一致します。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Skip the form inside the #payment-frame iframe
Results results = new AxeSelenium()
    .exclude(new FromFrames("#payment-frame", "form"))
    .run(driver);

exclude(FromShadowDom)

明示的なFromShadowDomセレクターを使用して、1つまたは複数のネストされたシャドウDOMツリー内の要素をスキャンから除外します。

public AxeSelenium exclude(FromShadowDom fromShadowDom);

パラメータ

名前 タイプ 説明
fromShadowDom FromShadowDom 最後以外の各セレクターはシャドウホストに一致し、最後が最も内側のシャドウルート内で除外する要素に一致します。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Skip the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
    .exclude(new FromShadowDom(".app-header", "form#search"))
    .run(driver);

exclude(Object)

単一のオブジェクトとして提供されたセレクターを使用してスキャンからエリアを除外します。引数の静的型が上記の型のいずれでもない場合、Javaはこのオーバーロードを選択します。例えばObjectとして宣言された変数の場合です。型指定されたオーバーロードを優先してください。

public AxeSelenium exclude(Object selector);

パラメータ

名前 タイプ 説明
selector Object CSSセレクターの文字列、文字列のリスト、FromFramesセレクター、またはFromShadowDomセレクター。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// The selector's type is chosen at runtime, so it's held as Object
Object skip = adInFrame ? new FromFrames("#ad-frame", ".ad") : ".ad";
Results results = new AxeSelenium()
    .exclude(skip)
    .run(driver);

exclude(Object...)

他のオーバーロードでは表現できないケースに対して、プレーンなCSSセレクターとFromFramesまたはFromShadowDomセレクターを混ぜて使用するセレクターを使用して、スキャンからエリアを除外します。すべての引数が一つの要素への単一のパスを形成し、それらは個別の除外ではありません。

このオーバーロードは、呼び出しが複数の引数を渡すときに選択されます。単一のFromFramesまたはFromShadowDomを渡すと、代わりにexclude(FromFrames)またはexclude(FromShadowDom)が選択されます。

シャドウルート内にあるiFrameに到達するには、FromShadowDomセレクターをFromFramesセレクターの中にネストします。その逆は表現できません。なぜならFromShadowDomは文字列しか受け付けないからです。

public AxeSelenium exclude(Object... selector);

パラメータ

名前 タイプ 説明
selector Object... スキップする要素への単一パスを形成する、CSSセレクターとセレクターオブジェクトの混合セット。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Skip .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
    .exclude("#frame", new FromShadowDom("#host", ".target"))
    .run(driver);

accordingTo(String...)

Runs only the rules that carry at least one of the given tags, such as wcag2a or best-practice. Use it to test against part of a standard, for example only WCAG 2.0 Level A, rather than a whole ルールセット.

accordingToとcheckingOnlyが同じオプションを設定するため、この2つの呼び出しの最後のもののみが有効になります。2回目のaccordingTo呼び出しも最初のタグからタグを置き換えるため、すべてのタグを1回の呼び出しで渡してください。

public AxeSelenium accordingTo(String... tags);

パラメータ

名前 タイプ 説明
tags String... 1つ以上のaxe-coreタグ。それぞれのルールにあるタグについてはルールの説明を参照してください。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Run only the WCAG 2.0 Level A and Section 508 rules
Results results = new AxeSelenium()
    .accordingTo("wcag2a", "section508")
    .run(driver);

checkingOnly(String...)

指定されたルールのみを実行し、他のルールは実行しません。特定の問題を修正している間に、1つまたは2つのルールにテストを集中させるために使用します。

checkingOnlyとaccordingToは同じオプションを設定するので、2つの呼び出しのうち最後のものだけが効果を持ちます。2回目のcheckingOnly呼び出しも最初のルールを置き換えるので、すべてのルールIDを一度に渡してください。

public AxeSelenium checkingOnly(String... rules);

パラメータ

名前 タイプ 説明
rules String... 1つまたは複数のaxe-coreルールID。ルールの説明をご覧ください。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Run only the label and color-contrast rules
Results results = new AxeSelenium()
    .checkingOnly("label", "color-contrast")
    .run(driver);

checking(String...)

指定したルールセットやaccordingToによって既に選択されたルールに加えて、名前付きルールをオンにします。選択されたタグやルールセットから除外されるルールを追加するために使用します。例えば、best-practiceルールなどです。

checkingとskippingは同じオプションを設定するので、2つの呼び出しのうち最後のものだけが効果を持ち、2回目のchecking呼び出しが最初のルールを置き換えます。すべてのルールIDを一度に渡し、同じスキャンでcheckingとskippingを組み合わせないでください。

public AxeSelenium checking(String... rules);

パラメータ

名前 タイプ 説明
rules String... 1つまたは複数のaxe-coreルールID。ルールの説明をご覧ください。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Run the WCAG 2.0 Level A rules, plus the tabindex best-practice rule
Results results = new AxeSelenium()
    .accordingTo("wcag2a")
    .checking("tabindex")
    .run(driver);

skipping(String...)

指定した名前のルールをオフにし、選択されたルールセットやタグの残りをそのままにします。ルールを完全にオフにするために使用します。ある要素の違反を削除し、ルールの他の結果を保持するには、代わりにignoringを使用してください。

skippingとcheckingは同じオプションを設定するので、2つの呼び出しのうち最後のものだけが効果を持ち、2回目のskipping呼び出しが最初のルールを置き換えます。すべてのルールIDを一度に渡し、同じスキャンでskippingとcheckingを組み合わせないでください。

public AxeSelenium skipping(String... rules);

パラメータ

名前 タイプ 説明
rules String... 1つまたは複数のaxe-coreルールID。ルールの説明をご覧ください。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Run the default ruleset without the color-contrast and image-alt rules
Results results = new AxeSelenium()
    .skipping("color-contrast", "image-alt")
    .run(driver);

forConfig(URL)

URLでスキャンする監査スイート(JSONルール設定ファイル)を選択します。これはAxeConfigurationにグローバル監査スイートを設定するため、後のAxeSeleniumスキャンにも適用されます。

監査スイートが設定されていない場合、Axe DevToolsはAXE_RULESET_PATH環境変数で指定されたファイルを使用します。または、それが設定されていない場合は、クラスパス上のconfig/axe-ruleset.jsonリソースを使用します。

public AxeSelenium forConfig(URL auditConfigPath);

パラメータ

名前 タイプ 説明
auditConfigPath URL 監査スイートファイルのURL。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

URL auditSuite = getClass().getResource("/config/my-audit-suite.json");
Results results = new AxeSelenium()
    .forConfig(auditSuite)
    .run(driver);

forConfig(String)

ファイルシステム上のパスでスキャンする監査スイートを選択します。forConfig(URL)のように、グローバル監査スイートを設定するため、後のスキャンにも適用されます。

public AxeSelenium forConfig(String auditConfigPath) throws MalformedURLException;

パラメータ

名前 タイプ 説明
auditConfigPath String 監査スイートファイルのファイルシステムパス。

戻り値

メソッドチェーン用のこのAxeSelenium。

スロー

パスがURLに変換できない場合のMalformedURLException。

例

Results results = new AxeSelenium()
    .forConfig("/opt/axe/my-audit-suite.json")
    .run(driver);

AxeSelenium.forRuleset(String)

Selects the ルールセット to scan with, such as wcag2.2 or 508, with best-practice rules turned off. The default ruleset is wcag2.1. If an audit suite is also configured, it modifies the selected ruleset.

これにより、AxeConfigurationにグローバルルールセットが設定されるため、以降のすべてのスキャンにも適用されます。ルールセットIDのリストについてはAxeConfiguration.forRuleset(String)をご覧ください。

public AxeSelenium forRuleset(String rulesetId);

パラメータ

名前 タイプ 説明
rulesetId String ルールセットのID。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

Results results = new AxeSelenium()
    .forRuleset("wcag2.2")
    .run(driver);

AxeSelenium.forRuleset(String, boolean)

ルールセットを使用してスキャンを選択し、ベストプラクティスルールを実行するかどうかを設定します。他の点ではAxeSelenium.forRuleset(String)と同様に動作し、ルールセットをグローバルに設定します。

public AxeSelenium forRuleset(String rulesetId, boolean enableBestPractices);

パラメータ

名前 タイプ 説明
rulesetId String ルールセットのID。
enableBestPractices boolean ベストプラクティスルールも実行するためのtrue。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// WCAG 2.1 rules plus best-practice rules
Results results = new AxeSelenium()
    .forRuleset("wcag2.1", true)
    .run(driver);

AxeSelenium.ignoring(String, String)

特定の要素でルールが失敗した際にそのルールの違反を走査結果から削除します。ルールはまだ実行され、成功を報告します。ルールごとに1回の呼び出しで十分です。一致すると、ルール全体のエントリーが削除されます。同じルールに対して2回呼び出さないでください。両方のセレクターが失敗した要素に一致した場合、スキャンはIllegalStateExceptionをスローします。

フィルタリングは全ルールに有効です。ルールに失敗する要素がセレクターと一致すると、他の要素での失敗を含むルール全体のエントリーが違反から削除されます。それを保持するには、代わりにexcludeでスキャンを絞り込んでください。

セレクターは、結果内で要素のtargetに正確に一致する必要があります。Javaがリストを印刷する方法で書かれています。ターゲットセレクターは角括弧の中にあり、"[#sidebar]"のように、またはiFrame内の要素に対して"[#frame, .ad]"です。手で書くのではなく、以前のスキャンの結果からコピーします。

public AxeSelenium ignoring(String attestSelector, String ruleId);

パラメータ

名前 タイプ 説明
attestSelector String 結果内に表示される要素のtarget。
ruleId String 無視する違反のルールID。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Ignore the known color-contrast violation on the sidebar
Results results = new AxeSelenium()
    .ignoring("[#sidebar]", "color-contrast")
    .run(driver);

disableIframeTesting()

Axe DevToolsがaxe-coreをiFrameに挿入したり、iFrameから結果を収集したりするのを停止し、最上位のドキュメントだけがテストされるようにします。iFrameのコンテンツが制御外である場合や、iFrameに挿入するとエラーが発生する場合に使用してください。

public AxeSelenium disableIframeTesting();

戻り値

メソッドチェーン用のこのAxeSelenium。

例

Results results = new AxeSelenium()
    .disableIframeTesting()
    .run(driver);

setTimeout(int)

ページを解析するためのaxe-coreの制限時間(秒単位)を設定します。スキャンがタイムアウトで失敗するまでの時間です。デフォルトは30秒です。非常に大きなページの場合はこれを延長してください。

public AxeSelenium setTimeout(int timeout);

パラメータ

名前 タイプ 説明
timeout int タイムアウトの秒数。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

Results results = new AxeSelenium()
    .setTimeout(120)
    .run(driver);

logResults(AxeReportingOptions)

runが完了すると、このスキャンのレポートを作成します。違反を一覧にした.logファイルと、完全な結果を含む.jsonファイルです。ファイル名と場所はreportingOptionsから取得します。AxeReportingOptionsをご覧ください。この呼び出しがないと、レポートファイルは作成されません。

reportingOptionsに行番号が設定されていない場合、Axe DevToolsはlogResultsを呼び出したテストの行を記録します。

public AxeSelenium logResults(AxeReportingOptions reportingOptions);

パラメータ

名前 タイプ 説明
reportingOptions AxeReportingOptions レポートの書き込み先と、テストの説明方法。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

// Writes axe-reports/checkout-page-loaded.log and .json
AxeReportingOptions options = new AxeReportingOptions()
    .testSuiteName("checkout")
    .uiState("page-loaded")
    .outputDirectory("axe-reports");

Results results = new AxeSelenium()
    .logResults(options)
    .run(driver);

loggingConfigured()

このAxeSeleniumでlogResultsが呼び出されているかどうかを報告します。

public boolean loggingConfigured();

戻り値

レポートオプションが設定されている場合のtrue。

enableTracking(boolean)

このAxeSeleniumに対してusage serviceをオンまたはオフにします。使用状況サービスはデフォルトでオンです。AXE_TRACK_USAGE環境変数が設定されている場合、それが優先され、このメソッドは効果を持ちません。trueはサービスをオンにし、他の値はサービスをオフにします。

public AxeSelenium enableTracking(boolean state);

パラメータ

名前 タイプ 説明
state boolean 使用状況データを送信するtrue、送信を停止するためのfalse。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

Results results = new AxeSelenium()
    .enableTracking(false)
    .run(driver);

trackingEnabled()

このAxeSeleniumが使用状況データを送信しているかを報告します。

public boolean trackingEnabled();

戻り値

使用状況サービスがオンの場合のtrue。

setTrackingUrl(String)

使用状況データが送信されるURLを設定します。デフォルトはAXE_METRICS_URL環境変数で、設定されていない場合はhttps://usage.deque.comです。AXE_METRICS_URLが設定されている場合、このメソッドは効果を持ちません。

public AxeSelenium setTrackingUrl(String url);

パラメータ

名前 タイプ 説明
url String 使用状況サービスのURL。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

Results results = new AxeSelenium()
    .setTrackingUrl("https://usage.example.com")
    .run(driver);

setDistinctId(String)

使用状況データと一緒に送信される固有のIDを設定します。これにより、使用状況サービスは1人のユーザーや1台のマシンからのイベントをグループ化できます。IDは~/.deque/distinct_idに保存されるため、同じマシンでの後の実行でも同じIDを使用し続けます。IDがAXE_DISTINCT_ID環境変数から取得された場合、このメソッドは効果を持ちません。

public AxeSelenium setDistinctId(String id);

パラメータ

名前 タイプ 説明
id String 固有のID。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

Results results = new AxeSelenium()
    .setDistinctId("build-agent-7")
    .run(driver);

setAnalyticsComponentName(String)

使用状況データと一緒に送信されるプロジェクト名を設定します。これにより、以前のこのAxeSeleniumでのsetTrackingUrlとenableTracking呼び出しをデフォルトにリセットしますので、これらのメソッドを呼び出す前に設定してください。setDistinctIdで設定された固有のIDは保持されます。

public AxeSelenium setAnalyticsComponentName(String name);

パラメータ

名前 タイプ 説明
name String プロジェクト名。

戻り値

メソッドチェーン用のこのAxeSelenium。

例

Results results = new AxeSelenium()
    .setAnalyticsComponentName("storefront-tests")
    .setDistinctId("build-agent-7")
    .run(driver);

com.deque.html.axecore.args.FromFrames

1つ以上の入れ子のiFrame内の要素をターゲットにするセレクター。includeまたはexcludeにAxeSeleniumで渡します。

import com.deque.html.axecore.args.FromFrames;

FromFrames(Object...)

入れ子のiFrameを通って1つの要素に至るパスからFromFramesセレクターを作成します。

public FromFrames(Object... selectors);

パラメータ

名前 タイプ 説明
selectors Object... iFrameのネストレベルごとに1つのセレクター、その後に最も内側のiFrame内の要素のセレクター。各エントリーはCSSセレクタ文字列、またはシャドウルート内にiFrameそのものが存在する場合はFromShadowDomセレクターです。

例

// The form inside #inner-frame, which is inside #outer-frame
FromFrames checkoutForm = new FromFrames("#outer-frame", "#inner-frame", "form");

// The main element inside an iframe that lives in the shadow root attached to #widget
FromFrames widgetFrame = new FromFrames(new FromShadowDom("#widget", "iframe"), "main");

getFromFrames()

入れ子のiFrameを通るパスを構成するセレクタを返します。

public List<Object> getFromFrames();

戻り値

List\<Object>としてのセレクタ。

setFromFrames(Object...)

入れ子のiFrameを通るパスを構成するセレクターを置き換えます。

public void setFromFrames(Object... fromFrames);

パラメータ

名前 タイプ 説明
fromFrames Object... 新しいパス、constructorが取る形と同じです。

例

FromFrames selector = new FromFrames("#frame", "form");
selector.setFromFrames("#frame", "nav");

com.deque.html.axecore.args.FromShadowDom

1つまたは複数の入れ子のシャドウDOMツリー内の要素をターゲットにするセレクター。includeまたはexcludeにAxeSeleniumで渡します。

import com.deque.html.axecore.args.FromShadowDom;

FromShadowDom(String...)

入れ子のシャドウルートを通って1つの要素に至るパスからFromShadowDomセレクターを作成します。

public FromShadowDom(String... selectors);

パラメータ

名前 タイプ 説明
selectors String... シャドウホストごとに1つのセレクタ、その後に最も内側のシャドウルート内の要素に対するセレクタです。

例

// The button inside the shadow root of .dialog, which is inside the shadow root of app-shell
FromShadowDom closeButton = new FromShadowDom("app-shell", ".dialog", "button.close");

getFromShadowDom()

入れ子になったシャドウルートを通るパスを構成するセレクタを返します。

public List<String> getFromShadowDom();

戻り値

List\<String>としてのセレクタ。

setFromShadowDom(String...)

入れ子になったシャドウルートを通るパスを構成するセレクタを置き換えます。

public void setFromShadowDom(String... fromShadowDom);

パラメータ

名前 タイプ 説明
fromShadowDom String... 新しいパス、constructorが取る形と同じです。

例

FromShadowDom selector = new FromShadowDom("app-shell", "nav");
selector.setFromShadowDom("app-shell", "footer");

com.deque.html.axedevtools.selenium.AxeDriver

Axe DevToolsが制御中のページにaxe-coreを注入できるようにSeleniumのWebDriverをラップします。各AxeSeleniumスキャンと各HamcrestマッチャーはAxeDriverを受け取ります。ページをナビゲートして相互作用するためにWebDriverを引き続き使用してください。

AxeDriver(WebDriver)

SeleniumのWebDriverのためのAxeDriverを作成します。

public AxeDriver(WebDriver webDriver);

パラメータ

名前 タイプ 説明
webDriver WebDriver チェックするページを制御するSeleniumのWebDriverです。

例

WebDriver webDriver = new ChromeDriver();
AxeDriver driver = new AxeDriver(webDriver);

webDriver.get("https://example.com");
Results results = new AxeSelenium().run(driver);

com.deque.html.axedevtools.selenium.AxeConfiguration

テスト実行の各スキャンに適用される設定を保持します。これにはaxe-coreスクリプト、監査スイート、ルールセット、およびレポートで使用されるデフォルトが含まれます。一つの共有インスタンスがあり、AxeConfiguration.configure()で取得します。任意のテストを実行する前に、一度設定してください。

AxeSelenium上のforRulesetやforConfigなどのメソッドもこの共有インスタンスを変更します。

// Code runs once before any tests are run
public void setupOnce() {
  AxeConfiguration.configure()
    .withAxeScript(axeURL)
    .forAuditSuite(auditURL)
    .forRuleset("508")
    .outputDirectory("my-axe-results");
}

configure()

共有AxeConfigurationインスタンスを返します。この静的メソッドはAxeConfigurationを取得する唯一の方法です。

public static AxeConfiguration configure();

戻り値

共有AxeConfigurationです。

例

AxeConfiguration config = AxeConfiguration.configure();

reset()

Replaces the shared configuration with a new one that has default settings. Use it between test classes that need different global settings. An AxeConfiguration you obtained before calling reset keeps its old settings, so call configure() again afterward.

public static void reset();

例

@AfterClass
public static void tearDown() {
    AxeConfiguration.reset();
}

forAuditSuite(URL)

各スキャンの監査スイート(JSONルール設定ファイル)をURLで選択します。監査スイートが設定されていない場合、Axe DevToolsはAXE_RULESET_PATH環境変数で指定されたファイル、または設定されていない場合はクラスパス上のconfig/axe-ruleset.jsonリソースを使用します。

public AxeConfiguration forAuditSuite(URL auditConfigPath);

パラメータ

名前 タイプ 説明
auditConfigPath URL 監査スイートファイルのURL。

戻り値

メソッドチェーン用のこのAxeConfiguration。

例

AxeConfiguration.configure()
    .forAuditSuite(getClass().getResource("/config/my-audit-suite.json"));

forAuditSuite(String)

ファイルシステム上のパスで各スキャンの監査スイートを選択します。

public AxeConfiguration forAuditSuite(String auditConfigPath) throws MalformedURLException;

パラメータ

名前 タイプ 説明
auditConfigPath String 監査スイートファイルのファイルシステムパス。

戻り値

メソッドチェーン用のこのAxeConfiguration。

スロー

パスがURLに変換できない場合のMalformedURLException。

例

AxeConfiguration.configure()
    .forAuditSuite("/opt/axe/my-audit-suite.json");

withAxeScript(URL)

ページに注入されるaxe-coreスクリプトを選択します。Axe DevToolsにバンドルされているものではなく、特定のaxe-coreビルドを固定するために使用します。

public AxeConfiguration withAxeScript(URL axeScript);

パラメータ

名前 タイプ 説明
axeScript URL axe-coreスクリプトのURLです。

戻り値

メソッドチェーン用のこのAxeConfiguration。

例

AxeConfiguration.configure()
    .withAxeScript(getClass().getResource("/axe.min.js"));

AxeConfiguration.forRuleset(String)

最適なプラクティスルールをオフにしたルールセットを各スキャンに選択します。デフォルトのルールセットはwcag2.1です。

public AxeConfiguration forRuleset(String rulesetId);

パラメータ

名前 タイプ 説明
rulesetId String 以下のルールセットIDのいずれか。

ルールセットIDは次のとおりです。

  • wcag2
  • wcag2.1
  • wcag2.2
  • wcag2aaa
  • wcag2.1aaa
  • wcag2.2aaa
  • 508
  • ttv5
  • en301549
  • rgaav4

戻り値

メソッドチェーン用のこのAxeConfiguration。

例

AxeConfiguration.configure().forRuleset("wcag2.2");

AxeConfiguration.forRuleset(String, boolean)

各スキャンのためのルールセットを選択し、最適なプラクティスルールを実行するかどうかも指定します。

public AxeConfiguration forRuleset(String rulesetId, boolean enableBestPractices);

パラメータ

名前 タイプ 説明
rulesetId String ルールセットIDについてはAxeConfiguration.forRuleset(String)を参照してください。
enableBestPractices boolean ベストプラクティスルールも実行するためのtrue。

戻り値

メソッドチェーン用のこのAxeConfiguration。

例

AxeConfiguration.configure().forRuleset("508", true);

getTestSuiteName()

レポートで使用されるデフォルトのテストスイート名を返します。デフォルトはaxe-runです。

public String getTestSuiteName();

AxeConfiguration.testSuiteName(String)

レポートファイル名とレポート内容で使用されるデフォルトのテストスイート名を設定します。AxeReportingOptions.testSuiteName(String)値は1つのレポートのためにそれを上書きします。

public AxeConfiguration testSuiteName(String testSuiteName);

パラメータ

名前 タイプ 説明
testSuiteName String テストスイート名。

戻り値

メソッドチェーン用のこのAxeConfiguration。

例

AxeConfiguration.configure().testSuiteName("storefront");

AxeConfiguration.getOutputDirectory()

レポートが書き込まれるデフォルトのディレクトリを返します。デフォルトはaxe-reportsです。

public String getOutputDirectory();

AxeConfiguration.outputDirectory(String)

レポートが書き込まれるデフォルトのディレクトリを設定します。ディレクトリが存在しない場合、レポート作成時に作成されます。AxeReportingOptions.outputDirectory(String)値は1つのレポートのためにそれを上書きします。

public AxeConfiguration outputDirectory(String outputDirectory);

パラメータ

名前 タイプ 説明
outputDirectory String ディレクトリパス。

戻り値

メソッドチェーン用のこのAxeConfiguration。

例

AxeConfiguration.configure().outputDirectory("target/axe-reports");

AxeConfiguration.getUserAgent()

レポートに記録されたデフォルトのユーザーエージェントを返します。設定されていない場合は、nullです。

public String getUserAgent();

AxeConfiguration.userAgent(String)

レポートに記録されるデフォルトのユーザーエージェントを設定します。これはラベルのみであり、ブラウザが送信するユーザーエージェントを変更しません。AxeReportingOptions.userAgent(String)値は1つのレポートのためにそれを上書きします。

public AxeConfiguration userAgent(String userAgent);

パラメータ

名前 タイプ 説明
userAgent String 記録するユーザーエージェント。

戻り値

メソッドチェーン用のこのAxeConfiguration。

例

AxeConfiguration.configure().userAgent("Chrome 130 headless");

AxeConfiguration.getTestMachine()

レポートに記録されるデフォルトのテストマシン名を返します。設定されていない場合は、nullです。

public String getTestMachine();

AxeConfiguration.testMachine(String)

レポートに記録されるデフォルトのテストマシン名を設定します。AxeReportingOptions.testMachine(String)値は1つのレポートのためにそれを上書きします。

public AxeConfiguration testMachine(String testMachine);

パラメータ

名前 タイプ 説明
testMachine String テストマシン名。

戻り値

メソッドチェーン用のこのAxeConfiguration。

例

AxeConfiguration.configure().testMachine(System.getenv("HOSTNAME"));

com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions

1つのレポートについて説明します。記録する場所、テストスイート、UI状態、ユーザーエージェント、テストマシン、行番号を含みます。logResultsに渡します。ReportingOptionsを実装しています。

設定しない値は対応するAxeConfiguration設定にフォールバックします。レポートファイルの名前は<test suite name>-<UI state>.logと.jsonです。テストスイート内の各チェックに独自のUI状態を与えないと、後のレポートが先のレポートを上書きします。

AxeReportingOptions()

設定されていない値でAxeReportingOptionsを作成しますので、すべての値はAxeConfigurationから取得します。レポートが書き込まれる前に、UI状態はデフォルトがなく、設定されなければなりません。

public AxeReportingOptions();

例

AxeReportingOptions options = new AxeReportingOptions()
    .uiState("home-page");

defaultAuditReportingOptions()

新しいオプションを返し、出力ディレクトリtarget/axe-report、テストスイート名accessibility、UI状態checkを持ち、レポートはtarget/axe-report/accessibility-check.logと.jsonに書き込まれます。これらは、logResultsを呼ばないときにHamcrestisAuditedForAccessibility()マッチャーが使用するオプションです。

public static AxeReportingOptions defaultAuditReportingOptions();

戻り値

新しいAxeReportingOptionsです。

例

Results results = new AxeSelenium()
    .logResults(AxeReportingOptions.defaultAuditReportingOptions())
    .run(driver);

getSuiteTestName()

このレポートのテストスイート名を返します。または、設定されていない場合はAxeConfigurationのデフォルトです。

public String getSuiteTestName();

AxeReportingOptions.testSuiteName(String)

このレポートのテストスイート名を設定します。それはレポートファイル名の最初の部分です。

public AxeReportingOptions testSuiteName(String testSuiteName);

パラメータ

名前 タイプ 説明
testSuiteName String テストスイート名。

戻り値

メソッドチェーン用のこのAxeReportingOptions。

例

AxeReportingOptions options = new AxeReportingOptions()
    .testSuiteName("checkout")
    .uiState("payment-step");

getUiState()

このレポートのUI状態を返します。

public String getUiState();

スロー

設定されていない場合のMissingUIStateExceptionです。

uiState(String)

このレポートのUI状態を設定します。ページがチェックされたときの外観を表す短い名前です。例えば、menu-openやform-errorsなどです。それはレポートファイル名の第2部分で、必要です。これがない状態でレポートを作成すると、MissingUIStateExceptionがスローされます。

public AxeReportingOptions uiState(String uiState);

パラメータ

名前 タイプ 説明
uiState String UI状態名。

戻り値

メソッドチェーン用のこのAxeReportingOptions。

例

webDriver.findElement(By.id("menu-button")).click();

Results results = new AxeSelenium()
    .logResults(new AxeReportingOptions().uiState("menu-open"))
    .run(driver);

AxeReportingOptions.getOutputDirectory()

このレポートが書き込まれるディレクトリを返します。または、設定されていない場合はAxeConfigurationのデフォルトです。

public String getOutputDirectory();

AxeReportingOptions.outputDirectory(String)

このレポートが書き込まれるディレクトリを設定します。存在しないディレクトリはレポート作成時に作成されます。

public AxeReportingOptions outputDirectory(String outputDirectory);

パラメータ

名前 タイプ 説明
outputDirectory String ディレクトリパス。

戻り値

メソッドチェーン用のこのAxeReportingOptions。

例

AxeReportingOptions options = new AxeReportingOptions()
    .outputDirectory("target/axe-reports/checkout")
    .uiState("cart");

getFileName()

拡張子なしのレポートファイル名を返します。テストスイート名とUI状態がハイフンで結合されており、useUniqueFilenameがオンの場合、タイムスタンプが続きます。

public String getFileName();

getFilePath(String)

レポートファイルのフルパスを返します。出力ディレクトリ、/、ファイル名、extensionです。

public String getFilePath(String extension);

パラメータ

名前 タイプ 説明
extension String .jsonのように、先頭のドットを含むファイル拡張子です。

戻り値

ファイルパス。

例

AxeReportingOptions options = new AxeReportingOptions()
    .testSuiteName("checkout")
    .uiState("cart")
    .outputDirectory("axe-reports");

String jsonPath = options.getFilePath(".json"); // axe-reports/checkout-cart.json

useUniqueFilename(boolean)

レポートファイル名にUTCタイムスタンプを追加します。これにより、同じチェックを再度実行したときに前のレポートを上書きするのではなく、新しいファイルを書き込むことができます。

このメソッドはReportingOptionsインターフェースを返し、AxeReportingOptionsではありません。したがって、例のようにそれを個別のステートメントとして呼び出し、AxeReportingOptionsに割り当てたりlogResultsに渡したりするチェーンの一部として使用しないでください。.logと.jsonファイル名は別々に作成されるため、そのタイムスタンプはわずかに異なる場合があります。

public ReportingOptions useUniqueFilename(boolean uniqueFilename);

パラメータ

名前 タイプ 説明
uniqueFilename boolean ファイル名にタイムスタンプを追加するためのtrue。

戻り値

このオブジェクトはReportingOptionsとして型付けされています。

例

AxeReportingOptions options = new AxeReportingOptions()
    .testSuiteName("nightly")
    .uiState("home");
options.useUniqueFilename(true);

AxeReportingOptions.getUserAgent()

このレポートに記録されたユーザーエージェントを返します。設定されていない場合はAxeConfigurationのデフォルトを返します。

public String getUserAgent();

AxeReportingOptions.userAgent(String)

このレポートに記録されたユーザーエージェントを設定します。これはラベルに過ぎず、ブラウザが送信するユーザーエージェントを変更するものではありません。

public AxeReportingOptions userAgent(String userAgent);

パラメータ

名前 タイプ 説明
userAgent String 記録するユーザーエージェント。

戻り値

メソッドチェーン用のこのAxeReportingOptions。

例

String userAgent = (String) ((JavascriptExecutor) webDriver).executeScript("return navigator.userAgent");
AxeReportingOptions options = new AxeReportingOptions()
    .userAgent(userAgent)
    .uiState("home");

AxeReportingOptions.getTestMachine()

このレポートに記録されたテストマシン名を返します。設定されていない場合はAxeConfigurationのデフォルトを返します。

public String getTestMachine();

AxeReportingOptions.testMachine(String)

このレポートに記録されたテストマシン名を設定します。

public AxeReportingOptions testMachine(String testMachine);

パラメータ

名前 タイプ 説明
testMachine String テストマシン名。

戻り値

メソッドチェーン用のこのAxeReportingOptions。

例

AxeReportingOptions options = new AxeReportingOptions()
    .testMachine("ci-linux-04")
    .uiState("home");

getLineNum()

このレポートに記録されたテスト行番号を返します。設定されていない場合はnullを返します。

public String getLineNum();

lineNum(String)

既に設定されている値を置き換えて、このレポートに記録されたテスト行番号を設定します。ほとんどの場合、必要ありません: logResultsは行番号が設定されていないときに呼び出し行を自動的に記録します。

public AxeReportingOptions lineNum(String lineNum);

パラメータ

名前 タイプ 説明
lineNum String 行番号。

戻り値

メソッドチェーン用のこのAxeReportingOptions。

例

AxeReportingOptions options = new AxeReportingOptions()
    .lineNum("42")
    .uiState("home");

lineNumIfEmpty(String)

まだ設定されていない場合にのみ、テスト行番号を設定します。logResultsはlineNumで設定した値を上書きせずに呼び出し行を記録します。

このメソッドはReportingOptionsインターフェースを返し、AxeReportingOptionsではありません。したがって、それを個別のステートメントとして呼び出し、AxeReportingOptionsに割り当てたりlogResultsに渡したりするチェーンの一部として使用しないでください。

public ReportingOptions lineNumIfEmpty(String lineNum);

パラメータ

名前 タイプ 説明
lineNum String 行番号。

戻り値

このオブジェクトはReportingOptionsとして型付けされています。

com.deque.html.axedevtools.selenium.reporter.MissingUIStateException

A RuntimeException thrown when a report is written with reporting options that have no UI state, with the message "Please provide the UI State of the current page under test". To avoid it, call uiState on every AxeReportingOptions you pass to logResults.

com.deque.html.axedevtools.selenium.results.ResultsFilter

結果から除外する要素とルールのペアを保持します。各AxeSeleniumは独自のResultsFilterを作成し、AxeSelenium.ignoring(String, String)を使用して追加します。自分で1つを作成するのではなく、既に持っているResultsオブジェクトをフィルタリングするためにResultsFilterを直接使用することもできます。

filterIgnoredViolations(Results)

Removes the ignored violations from results. A rule's entire entry is removed from the violations when the rule ID matches and any of its nodes has a target equal to an ignored selector, even if other nodes don't match. The Results object you pass in is modified and returned.

public Results filterIgnoredViolations(Results results);

パラメータ

名前 タイプ 説明
results Results フィルタリングする結果。

戻り値

無視された違反が削除された同じResultsオブジェクト。

例

Results results = new AxeSelenium().run(driver);

new ResultsFilter()
    .ignoring("[#legacy-widget]", "aria-allowed-attr")
    .filterIgnoredViolations(results);

ResultsFilter.ignoring(String, String)

無視する要素とルールのペアを追加します。セレクターはノードのtargetに正確に一致しなければなりません。形式は"[#sidebar]"です。AxeSelenium.ignoring(String, String)を参照してください。

public ResultsFilter ignoring(String cssSelector, String ruleId);

パラメータ

名前 タイプ 説明
cssSelector String 結果内に表示される要素のtarget。
ruleId String 無視する違反のルールID。

戻り値

メソッドチェーン用のこのResultsFilter。

例

ResultsFilter filter = new ResultsFilter()
    .ignoring("[#sidebar]", "color-contrast")
    .ignoring("[.third-party-iframe]", "frame-title");

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

.logと.jsonレポートファイルをスキャンのために書き込みます。AxeSeleniumとHamcrestマッチャーはlogResultsを呼び出すときにこれを使用します。すでに持っているResultsを報告するためにのみ直接使用します。

AxeDevtoolsReporter()

AxeDevtoolsReporterを作成します。

public AxeDevtoolsReporter();

例

AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();

generateReport(Results, String)

results内の違反のプレーンテキストサマリーを返します。各ルールのヘルプテキストとURL、影響を受けた各ノードのターゲット、および修正するチェックが続き、結果を生成したコマンドが続きます。これは.logファイルに書き込まれるテキストであり、アサーションが失敗したときにHamcrestisAxeClean()マッチャーが表示するテキストです。

public String generateReport(Results results, String executedCommand);

パラメータ

名前 タイプ 説明
results Results スキャンの結果。
executedCommand String レポートに含めるコマンドテキスト。たとえば、runCommand()から。

戻り値

レポートのテキスト。

例

AxeSelenium axe = new AxeSelenium();
Results results = axe.run(driver);

String report = new AxeDevtoolsReporter().generateReport(results, axe.runCommand());
System.out.println(report);

report(ReportingOptions, Results, String)

resultsのレポートをreportingOptionsで指定されたパスに2つのファイルとして書き込みます。generateReportテキストの.logファイルと、全結果の.jsonファイルです。reportingOptionsがnullの場合、何も書き込まれません。

public void report(ReportingOptions reportingOptions, Results results, String executedCommand);

パラメータ

名前 タイプ 説明
reportingOptions ReportingOptions レポートを書き込む場所。通常はAxeReportingOptionsです。
results Results スキャンの結果。
executedCommand String 結果を生成したコマンド。

スロー

reportingOptionsにUI状態がない場合のMissingUIStateException、またはファイルが書き込めない場合のRuntimeException。

例

AxeSelenium axe = new AxeSelenium();
Results results = axe.run(driver);

new AxeDevtoolsReporter().report(
    new AxeReportingOptions().uiState("after-login"),
    results,
    axe.runCommand());

com.deque.html.axedevtools.utils.FileUtils

Axe DevToolsが内部で使用するレポートファイルの読み書き用のヘルパー。テストでの使用は意図していません。