axe-devtools-robot APIリファレンス

このライブラリはAxe DevToolsを利用して、Robot Frameworkでアクセシビリティのテストを行うことができます。

axe_devtools_robot.AxeRobot

SeleniumLibraryを拡張しているため、SeleniumLibraryで利用できるすべてのキーワードはAxeRobotでも利用可能です。

テストスイートの設定セクションにライブラリをインポートします:

*** Settings ***
Library  axe_devtools_robot.AxeRobot

Analyze

ページ上でaxe-coreを実行し、違反がある場合はテストを失敗とします。

Audit For Accessibility

ページでaxe-coreを実行し、結果をaxe-reportsディレクトリに保存します。.logファイル（違反報告）と.jsonファイル（完全な結果）の両方が作成されます。失敗しません。

Within

ページの一部を指定してaxe-coreに分析させます。

selectors: 含める要素のための1つ以上のCSSセレクタ。

Excluding

分析中にaxe-coreがスキップするページの一部を指定します。

selectors: 除外する要素のための1つ以上のCSSセレクタ。

According To

axe-coreを実行するためのルール（タグによって）を指定します。

tags: 1つ以上のタグ名。使用可能なタグの一覧はaxe-coreのタグを参照してください。

According To Ruleset

axe-coreの実行用に特定のルールセットを使用します。

ruleset: 使用するルールセットのID。利用可能なルールセット: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4。

enable_best_practices: best-practiceでタグ付けされたルールを有効にするかどうか。デフォルトはFalseです。

Checking Only

axe-coreを実行するルール（IDによって）を指定します。指定されたルールのみが使用されます。

rules: 1つ以上のルールID。使用可能なIDの一覧はルールの説明を参照してください。

Skipping

axe-coreの実行から特定のルールを無効にします。

rules: 1つ以上のルールID。

idCSSセレクタの使用について

Robot Frameworkは#文字を特別なものとして扱います。#をエスケープしない限り、Robotは行の残りをコメントとして解釈します。

実際には、単に#の代わりに\#を使用する必要があります。

詳細についてはロボットのドキュメントを参照してください。

例

*** Settings ***
Library  axe_devtools_robot.AxeRobot
Suite Setup  Set Log Level  DEBUG


*** Test Cases ***
Analyzes
  Open Browser  http://localhost:8000/example-page.html  Chrome
  Analyze
Audits
  Open Browser  http://localhost:8000/example-page.html  Chrome
  Audit For Accessibility

Uses Within
  Open Browser  http://localhost:8000/example-page.html  Chrome
  Within  body
  Analyze
Close browsers
  Close All Browsers