スキャンの実行

準備、位置について、スキャン

AxeDevToolsライブラリをインポートして初期化したら、スキャンの準備が整います。テスト内でaxe.scan()を呼び出してスキャンを実行します。

サンプルスキャン

テスト内でスキャンを実行する準備ができたら、axe.scan()を呼び出します。以下の例では、ScanResultHandlerを使用して結果をAxe Developer Hubにアップロードし、テストを合格または失敗にし、結果をチームと共有したり報告したりするためにローカルに保存する方法を示しています。この機能の詳細はスニペットの下に記載されています。

private fun a11yScan() {

    val scanResultHandler = axe.scan()

    //1. Upload it to both Developer Hub and the Mobile Dashboard
    scanResultHandler?.uploadToDashboard()

    //2. Use the results in your test suite
    val result: AxeResult? = scanResultHandler?.getSerializedResult()
    result?.axeRuleResults?.forEach { result ->
        if(result.status == AxeStatus.PASS) {
            ...
        }
        else if(result.status == AxeStatus.FAIL) {
            ...
        }
        else if(result.status == AxeStatus.INCOMPLETE) {
            ...
        }
    }

    //3. Save the result JSON to a local file for later use
    scanResultHandler?.saveResultToLocalStorage("your_file_prefix")
}

詳細説明：

1. 結果ハンドラからuploadToDashboard()を呼び出して、最新のスキャンをAxe Developer Hubに送信します。スキャンはinit関数で使用された認証済みアカウントから公開されます。
2. 結果ハンドラからgetSerializedResult()を呼び出して、ライブラリの結果にローカルでアクセスします。例えば、アクセシビリティスキャン結果で失敗が検出された場合、テストを失敗とすることができます。これにより、結果がサーバーにアップロードされることはありません。結果をローカルにダウンロードするためにアップロードする必要はありません。
3. 結果ハンドラからsaveResultToLocalStorage()を呼び出して、結果をJSONとしてテストデバイスのローカルファイルに保存します。保存されたファイルにアクセスするには、結果をローカルに保存するのドキュメントを参照してください。

初期化解除

テストが完了したら、AxeDevToolsオブジェクトでtearDown()を呼び出して、前のテストの状態をクリアします。これをテストファイルの@After注釈付き関数に配置することをお勧めしますが、必要に応じてテスト内で呼び出すこともできます。

@After
fun tearDown() {
    axe.tearDown()
}

次はどうする？

Axe Developer Hubへのスキャン結果のアップロードと結果をローカルに保存するについてさらに詳しく学びましょう。