Javaでレポートを生成する

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

JavaでAxe DevTools for Webリポーターを使用する

Not for use with personal data

このガイドでは、既にAxe DevTools for Webを利用しているテストプロジェクトにAxe DevToolsリポーターを追加する方法を詳しく解説します。

前提条件

リポーターの統合には、Axe DevTools for Webのテスト設定が稼働していることが必要です。Axe DevTools for Webのスキャン結果をまだ得ていない場合は、JavaでのAxe DevToolsをセットアップする方法に関するガイドをお読みください。

また、リポーター実行可能ファイルを入手する必要があります。それはダウンロードページからバイナリリポーターことができます。そして、ダウンロード後のバイナリの準備セクションを必ずご確認ください。

リポーターのセットアップ

リポーターを使用するには、それを個別のステートメントでインポートする必要があります。<binding>を使用しているテスト設定のパッケージに応じて、seleniumhamcrest、またはcucumberに置き換えてください。

import com.deque.html.axedevtools.<binding>.*;
import com.deque.html.axedevtools.<binding>.reporter.*;

次に、いくつかの初期化ステートメントが必要です。<reporter-binary>をリポーターの実行可能ファイルの名前に置き換えます。リポーター実行可能ファイルの入手については、上記の前提条件をご覧ください。その名前はOSに依存します。

static String reporter = new File("src/test/resources/<reporter-binary>").getAbsolutePath();

次に、レポート設定を初期化します

private AxeReportingOptions _reportOptions = new AxeReportingOptions();

最後に、テストスイート名とログファイルの出力ディレクトリを指定します

AxeConfiguration.configure()
    .testSuiteName("<suite-name>")
    .outputDirectory("<log-directory-location>");

リポーターを使用したテストの作成

スキャンを実行してテストを書いている際に、ロガーはスキャン結果をファイルに保存しますので、リポーターはそれらをアクセスしてコンパイルできます。レポートを作成したい各スキャンについて、.logResults()チェーンメソッドを追加します。ここで、将来の参照のためにレポートに名前を付けることができます。

.logResults(_reportOptions.uiState("<scan-name>"))

レポートの生成

最後に、リポーターが設定され、結果がログされると、リポーターは結果にアクセスして変換できます。通常、このステップはテストスイート内のすべてのスキャンが終了した後に実行されます。このコードスニペットはリポーターバイナリを実行します。リポーターは3つの引数を取ります: ロガーの結果がAxeConfigurationに設定され、そのレポートの完成した出力の望ましい宛先とその希望する形式です。ローカルのテスト設定では、htmlを選択することをお勧めします。CIの使用には、xmlオプションが多くのCI環境に適合するJUnit xmlレポートを生成します。他のツールへのエクスポートには、csvを使用してください。

Runtime rt = Runtime.getRuntime();
String command = reporter + " <log-directory-location> <desired-destination> --format <desired-format>";
rt.exec(command);

トラブルシューティング

リポーターに関する問題が続く場合は、直接Deque担当者に連絡するか、私たちのサポートデスクを通じて、あるいはメールを送信するしてください。お手伝いいたします。

関連項目