SeleniumのAPIリファレンス

このドキュメントは、seleniumパッケージによって提供される型のリファレンスです。AxeSeleniumクラスはほとんどの使用ケースをカバーしており、AxeConfigurationが残りをカバーします。

com.deque.html.axedevtools.selenium.AxeSelenium

axeの実行方法を設定し、実際にaxeを実行します。

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

AxeSelenium()

AxeDriver用の新しいAxeSeleniumアクセシビリティチェックを作成します。

AxeSelenium(final AxeBuilder axeBuilder, final AxeConfiguration axeConfiguration, final ResultsFilter resultsFilter, final AxeDevtoolsReporter reporter)

AxeDriver用の新しいAxeSeleniumアクセシビリティチェックを作成します。

Results run(final AxeDriver page)

axe.runを使用してページに対してaxeを実行します。

page: a11yチェックを行うページを表すAxeDevTools Driver。

結果のドキュメントを返します。

AxeSelenium include(final String cssSelector)

セレクタを含めます。

cssSelector: 有効なCSSセレクタ。 AxeSeleniumを返し、メソッドチェーンを可能にします。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium include(final List<String> selector)

iFrameセレクタを含めます。

selector: ネストされたiFrameセレクタのリスト。 各セレクタはネストレベル用のCSSセレクタを表します。 最後のセレクタは、最も内側のiFrame内のウェブ要素をチェックするためのCSSセレクタを表します。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium exclude(final String cssSelector)

セレクタを除外します。

cssSelector: 有効なCSSセレクタ。 メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium exclude(final List<String> selector)

セレクタを除外します。

selector: ネストされたiFrameセレクタのリスト。 各セレクタはネストレベル用のCSSセレクタを表します。 最後のセレクタは、最も内側のiFrame内のウェブ要素をチェックするためのCSSセレクタを表します。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium accordingTo(final String... tags)

アクセシビリティタグに従って。指定されたアクセシビリティタグのみをチェックします。このオプションはAxeSelenium::checkingOnlyと互換性がありません ルールの説明を参照してください。

tags: チェックするタグのリスト。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium checkingOnly(final String... rules)

アクセシビリティルールのみをチェックします。このオプションはAxeSelenium::accordingToと互換性がありません ルールの説明を参照してください。

rules: チェックするルールのリスト。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium checking(final String... rules)

アクセシビリティルールをチェックします。指定されたタグに加えて、特定のルールもチェックします。 ルールの説明を参照してください。

rules: チェックするルールのリスト。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium skipping(final String... rules)

アクセシビリティルールをスキップします。指定されたタグ内から、特定のルールのチェックをスキップします。 ルールの説明を参照してください。

rules: チェックするルールのリスト。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium forConfig(final URL auditConfigPath)

URLで監査スイートを提供します。

auditConfigPath: 監査スイートに関連付けられたURL。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium forConfig(final String auditConfigPath) throws MalformedURLException

ファイルシステム上の場所によって監査スイートを提供します。

auditConfigPath: 監査スイートの絶対ファイルパス。

メソッドチェーンのためにAxeSeleniumを返します。

監査パスが無効なファイルシステムパスの場合、MalformedURLExceptionをスローします。

AxeSelenium forRuleset(final String rulesetId)

アクセシビリティチェックのためのルールセットを指定します。監査スイートを設定することで、指定されたルールセットが変更されます。 ルールセットを参照してください。

rulesetId: 設定のためのルールセットID。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

アクセシビリティチェックのためのルールセットを指定します。監査スイートを設定することで、指定されたルールセットが変更されます。 ルールセットを参照してください。

rulesetId: 設定のためのルールセットID。

enableBestPractices: 「ベストプラクティス」ルールを有効にするかどうか。

AxeSelenium: メソッドチェーンのため。

AxeSelenium ignoring(final String selector, final String ruleId)

選択されたセレクターと指定されたルールIDの違反を無視します。

selector: Axe DevToolsアクセシビリティ/監査スイートによって生成されたセレクター。

ruleId: 指定されたセレクターのために無視するルールID。

メソッドチェーンのためにAxeSeleniumを返します。

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

完了時にアクセシビリティチェックの結果を記録します。

reportingOptions: アクセシビリティチェックのシリアル化と永続化を定義するオプション。 メソッドチェーンのためにAxeSeleniumを返します。

boolean loggingConfigured()

ログが構成されているかどうか。

ログが構成されているかどうかを返します。

com.deque.html.axedevtools.selenium.AxeDriver

AxeDriverを使用してページと対話します。

セレンのウェブドライバーをラップして、axe-DevTools専用の機能を提供します。

AxeDriver(final WebDriver webDriver)

SeleniumのWebDriverからAxeDriverを作成します。

webDriver: チェックすべきページのためのSelenium WebDriver。

com.deque.html.axedevtools.selenium.AxeConfiguration

ファイルの場所や設定などのaxeスクリプトのプロパティを設定します。 シングルトンクラスです。AxeConfiguration.configure()を使用してアクセスします。

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

static AxeConfiguration configure()

axeアクセシビリティチェックを設定します。AxeConfigurationインスタンスを取得する唯一の方法です。

監査スイートをグローバルに設定するための設定オブジェクトを返します。

static void reset()

デフォルトの設定にリセットします。

AxeConfiguration forAuditSuite(final URL auditConfigPath)

監査スイートをそのURLで提供します。

auditConfigPath: 監査スイートに関連付けられたURL。

メソッドチェーンのためにAxeConfigurationを返します。

AxeConfiguration forAuditSuite(final String auditConfigPath) は、MalformedURLException をスローします

ファイルシステム上で監査スイートの場所を指定します。

auditConfigPath: 監査スイートの絶対ファイルパス。

メソッドチェーンのために AxeConfiguration を返します。

監査パスが無効なファイルシステムパスの場合、MalformedURLException をスローします。

AxeConfiguration withAxeScript(URL axeScript)

アクセシビリティチェックを実行するために使用する axe コアスクリプトを指定します。

axeScript: アクセシビリティチェックに使用される axe コアスクリプトに関連付けられた URL。

メソッドチェーンのために AxeConfiguration を返します。

AxeConfiguration forRuleset(final String rulesetId)

どのルールセットを実行するか選択します

rulesetId: 以下のいずれか:

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

メソッドチェーンのために AxeConfiguration を返します。

AxeConfiguration forRuleset(final String rulesetId, final boolean enableBestPractices)

どのルールセットを実行するか選択します

rulesetId: 可能な値については、上記 を参照してください。

enableBestPractices: 「ベストプラクティス」ルールを有効にするかどうか。

メソッドチェーンのために AxeConfiguration を返します。

String getTestSuiteName()

テストスイート名を取得します。

テストスイート名を返します。

AxeConfiguration testSuiteName(final String testSuiteName)

テストスイート名を設定します。レポートの生成に使用されます。

testSuiteName: テストスイートの名前。

メソッドチェーンのために AxeConfiguration を返します。

String getOutputDirectory()

レポートの出力ディレクトリを取得します。

出力ディレクトリのパスを返します。

AxeConfiguration outputDirectory(final String outputDirectory)

レポートを保存するディレクトリを設定します。

outputDirectory: ディレクトリへのパス。

メソッドチェーンのために AxeConfiguration を返します。

String getUserAgent()

ユーザーエージェントとして使用される値を取得します。

レポート生成に使用されたユーザーエージェントを返します。

AxeConfiguration userAgent(final String userAgent)

レポート生成時に使用されるユーザーエージェントの値を設定します。axe を実行する際に使用される実際のユーザーエージェントには影響しません。

userAgent: ユーザーエージェントの値。

メソッドチェーンのために AxeConfiguration を返します。

String getTestMachine()

テストマシンの名前を取得します。

テストマシンの名前を返します。

AxeConfiguration testMachine(final String testMachine)

テストマシンの名前を設定します。レポート生成で使用されます。

testMachine: テストマシンの名前。

メソッドチェーンのためにAxeConfigurationを返します。

com.deque.html.axedevtools.selenium.results.IgnoredViolation

IgnoredViolation(final String cssSelector, final String ruleId)

無視する違反を作成します。

cssSelector: 無視するノードのセレクタ。各ノードのターゲットと比較します。

ruleId: 無視するルールのID

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

レポートオプションを設定します。AxeConfigurationからデフォルト値を取得します。

AxeReportingOptions()

AxeReportingOptionsを作成します

static AxeReportingOptions defaultAuditReportingOptions()

デフォルトオプションを取得します。

デフォルトのオプションオブジェクトを返します。

String getSuiteTestName()

設定されたテストスイートの名前を取得します。

名前を返します。

AxeReportingOptions testSuiteName(final String testSuiteName)

テストスイートを説明します。

testSuiteName: テストスイートの名前。

メソッドチェーンのためにReportingOptionsを返します。

String getUiState()

設定されたUIの状態を取得します。

状態を返します。

AxeReportingOptions uiState(final String uiState)

アクセシビリティチェック中のUIの状態を説明します。

uiState: UIの状態。

メソッドチェーンのためにReportingOptionsを返します。

String getOutputDirectory()

設定された出力ディレクトリを取得します。

ディレクトリを返します。

AxeReportingOptions outputDirectory(final String outputDirectory)

アクセシビリティレポートを出力するためにルートoutputDirectoryを設定します。

outputDirectory: ディレクトリパス。

メソッドチェーンのためにReportingOptionsを返します。

String getFileName()

設定値から計算したファイル名。

ファイル名を返します。

String getFilePath(final String extension)

設定値からファイルパスを計算します。

パスを返します。

String getUserAgent()

設定されたユーザーエージェントを取得します。

ユーザーエージェントを返します。

AxeReportingOptions userAgent(final String userAgent)

アクセシビリティテストを実施するために使用されるユーザーエージェントを説明してください。

userAgent: ユーザーエージェント名。

メソッドチェーンのためのReportingOptionsを返します。

String getTestMachine()

設定されたテストマシンを取得します。

テストマシンを返します。

AxeReportingOptions testMachine(final String testMachine)

アクセシビリティテストを実施するために使用されるマシンを説明してください。

testMachine: マシン名。

メソッドチェーンのためのReportingOptionsを返します。

AxeReportingOptions lineNum(final String lineNum)

現在のテストの行番号を指定します。

lineNum: 現在のテストの行番号。

メソッドチェーンのためのReportingOptionsを返します。

ReportingOptions lineNumIfEmpty(final String lineNum)

まだ設定されていない場合、行番号を指定します。

lineNum: 現在のテストの行番号。

メソッドチェーンのためのReportingOptionsを返します。

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

UI状態が欠落している場合の例外。

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

無視する違反事項を設定します。

ResultsFilter filter = new ResultsFilter()
    .ignoring(".third-party-iframe", "label");
Results results = new AxeSelenium(axe, configuration, filter, reporter)
    .run(driver);

Results filterIgnoredViolations(final Results results)

無視された違反を除外するために結果をフィルタリングします。

results: フィルタリングする結果。

無視されたCSSセレクターとルールIDでフィルタリングされた、受信結果を返します。

ResultsFilter ignoring(final String cssSelector, final String ruleId)

無視される違反を追加します。

cssSelector: アクセシビリティ/監査スイートを実行することによって生成されたCSSセレクター。

ruleId: アクセシビリティ/監査スイートを実行することによって生成されたルールID。

メソッドチェーンのためのResultsFilterを返します。

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

hamcrest matcher使用時のレポートオプションを設定します。

AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();
assertThat(axeDevtoolsSelenium, isAxeClean(axeSelenium, reporter));

AxeDevtoolsReporter()

AxeDevtoolsReporterを構築します。

String generateReport(final Results results, final String executedCommand)

アクセシビリティチェックの文字列表現を作成します。

results: 監査チェックの結果。

executedCommand: 監査結果を生成するために実行されたコマンド。

発見されたアクセシビリティ違反の読みやすいレポートを返します。

void report(final ReportingOptions reportingOptions, final Results results, final String executedCommand)

アクセシビリティチェックについて報告します。レポートを日付ごとに結果ログファイルに追加します。完全な結果をJSONファイルとして保存します。

reportingOptions: レポートを記録するためのオプション。

results: 監査チェックの結果。

executedCommand: 監査結果を生成するために実行されたコマンド。

com.deque.html.axedevtools.reporter.TestResultsGenerator

TestResultsをResultsとReportingOptionsから生成します。 AxeDevtoolsReporterと一緒に使用します。

TestResults generate(final ReportingOptions reportingOptions, final Results results)

{@link TestResults}を生成します。

reportingOptions: 結果を作成するためのオプション。

results：axeの実行結果。

テストの戻り値

com.deque.html.axedevtools.reporter.ViolationsReporter

違反のみを報告します。

com.deque.html.axedevtools.utils.FileUtils

内部使用のためのファイルユーティリティ。