スキャンの実行

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

ライブラリをインポートし初期化した後は、 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として結果を保存します。保存されたファイルにアクセスするには、 結果をローカルに保存するについてのドキュメントを参照してください。

初期化解除

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

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

次はどうする？

結果をaxe Developer Hubにアップロードする方法や スキャン結果をアップロードする こと、および 結果をローカルに保存する方法についてもっと学びましょう。