CucumberのAPIリファレンス
Axe DevTools for Web JavaのAxeWorldクラスに関するAPIリファレンス
このドキュメントは、com.deque.html.axedevtools.cucumberパッケージ内のAxeWorldクラスのリファレンスです。SeleniumやHamcrestパッケージとは異なり、Cucumberパッケージにはスコープ設定やルール設定用のビルダーやマッチャークラスがありません。それらのオプションは、Cucumberテストを書くで説明されているように、直接Gherkinステップテキスト内で表現されます。AxeWorldクラスは、確認すべきページ、アナリティクス設定、カスタムレポートオプション、axe-coreのタイムアウトなど、Gherkinステップでは表現できない状態や設定のみを保持します。
com.deque.html.axedevtools.cucumber.AxeWorld
Holds the page and configuration used by the Cucumberアクセシビリティステップ when checking accessibility. Your dependency injection framework creates the AxeWorld (PicoContainer, for example, creates one per scenario) and passes it to both your step definitions and the Axe DevTools steps, so anything you set on it in a @Before hook or an earlier step applies to the accessibility steps in the same scenario.
設定はアクセシビリティステップが実行されるたびに読み取られます。セッターを呼び出した時点では何もチェックされず、送信されません。
public StepDefinitions(AxeWorld axeWorld) {
this.axeWorld = axeWorld;
}
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}AxeWorld()
ページや設定がない状態でAxeWorldを作成します。通常は自分で呼び出すことはありません。ステップ定義クラスのコンストラクタにAxeWorldパラメータを宣言し、依存性注入フレームワークがインスタンスを作成して共有します。
public AxeWorld();getPage()
アクセシビリティステップがチェックするページを返します。setPageが呼び出されていない場合はnullを返します。
public AxeDriver getPage();返される
このワールドに設定されたAxeDriver。
setPage(AxeDriver)
アクセシビリティステップがチェックするページを設定します。通常、@Beforeフックで実行する前に呼び出します。ステップは、ステップが実行された時点でラップされたWebDriverが表示しているページをチェックするので、通常通り前のステップでWebDriverでナビゲートします。
public void setPage(AxeDriver page);パラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
page |
AxeDriver |
Selenium WebDriver をラップする、検査するページです。 |
例
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}enableAnalytics(boolean)
アクセシビリティステップのために使用サービスをオンまたはオフにします。呼び出さなかった場合、使用サービスはオンです。AXE_TRACK_USAGE環境変数が設定されている場合、それが優先され、このメソッドの効果はありません:trueがサービスをオンにし、それ以外の値がオフにします。
public void enableAnalytics(boolean state);パラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
state |
boolean |
使用データを送信するtrue、送信を停止するfalse。 |
例
@Before
public void setup() {
axeWorld.enableAnalytics(false);
}setAnalyticsUrl(String)
送信先URLを設定します。デフォルトはAXE_METRICS_URL環境変数、またはそれが設定されていない場合はhttps://usage.deque.comです。AXE_METRICS_URLが設定されている場合、このメソッドの効果はありません。
public void setAnalyticsUrl(String url);パラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
url |
String |
使用サービスのURL。 |
例
axeWorld.setAnalyticsUrl("https://usage.example.com");setAnalyticsDistinctId(String)
使用データと共に送信される固有のIDを設定し、使用サービスが1人のユーザーまたは1つのマシンからのイベントをグループ化できるようにします。IDは~/.deque/distinct_idに保存されるため、同じマシンでの後の実行でもそれを使用し続けます。IDがAXE_DISTINCT_ID環境変数から来た場合、このメソッドの効果はありません。
public void setAnalyticsDistinctId(String did);パラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
did |
String |
固有のID。 |
例
axeWorld.setAnalyticsDistinctId(System.getenv("CI_RUNNER_ID"));setAnalyticsComponentName(String)
使用データと共に送信されるプロジェクト名を設定します。
アクセシビリティステップは、他の分析設定の後にコンポーネント名を適用し、それを設定するとURLとenableAnalyticsの値がデフォルトにリセットされます。このため、コンポーネント名を設定すると、同じAxeWorldにあるsetAnalyticsUrlやenableAnalyticsの値は無効になります。setAnalyticsDistinctIdの値はファイルに保存されているため保持されます。
public void setAnalyticsComponentName(String name);パラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
name |
String |
プロジェクト名。 |
例
axeWorld.setAnalyticsComponentName("storefront-features");setReportingOptions(AxeReportingOptions)
Then the page should be audited for accessibilityステップがレポートを書き込む場所とテストをどのように説明するかを設定します。それがない場合、そのステップはtarget/axe-report/accessibility-check.logと.jsonに書き込みます。オプションについてはAxeReportingOptionsを参照してください。渡したオプションがデフォルトを完全に置き換えます。設定しなかった値はAxeConfigurationに戻ります(レポートはoutputDirectoryを設定しない限りaxe-reportsに送られます)、uiStateを設定する必要があります。
レポートを書き込まないThen the page should be axe cleanステップには影響しません。
public void setReportingOptions(AxeReportingOptions reportingOptions);パラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
reportingOptions |
AxeReportingOptions |
使用するレポートオプション。 |
例
@Before
public void setup(Scenario scenario) {
axeWorld.setReportingOptions(new AxeReportingOptions()
.outputDirectory("target/axe-report")
.testSuiteName("checkout")
.uiState(scenario.getName().replaceAll("\\W+", "-")));
}setTimeout(int)
axe-coreがステップがタイムアウトで失敗する前にページを分析できる秒数を設定します。デフォルトは30秒です。非常に大きなページの場合はそれを引き上げます。
public void setTimeout(int timeout);パラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
timeout |
int |
タイムアウト(秒数)。 |
例
axeWorld.setTimeout(120);