結果をローカルに保存する

スキャン結果をローカルに保存すると、JSON結果を使ってアクセシビリティの指標を様々な報告ツールに統合することができます。また、HTMLレポートを作成してメールやチャットで共有し、テストランのアクセシビリティの状態をチームに通知することもできます。

結果をローカルに保存する機能は、自動テストでのみサポートされています。

結果を保存して共有する

以下のコードを使用してテスト結果を .json ファイルとして保存します。パスとファイル名が指定されていない場合、結果は "(APPID)-(CURRENT_SCREEN_TITLE).json" と名付けられ、 "AxeDevToolsResults" のフォルダ内に保存されます。 User フォルダ内に保存されます。スキャン名は、利用可能であればビューコントローラのタイトルをデフォルトで使用します。

try axe?.saveResult(result, toPath: "", withFileName: "", withScanName: "")

HTMLレポートとサマリーを生成する

テストの後処理に generateHtmlReportAndSummary を追加して、自己完結型のHTMLレポートを生成し、デバイスにローカル保存します。このAPI呼び出しは、保存済みの結果ファイルを全て消去し、セッション開始以降（またはメソッドの最後の呼び出し以降）に蓄積された全てのスキャンを集めます。 generateHtmlReportAndSummary を実行中に複数回呼び出すと、フローごとに別々のレポートが生成されます（例: 画面ごとまたは機能領域ごとに1つずつ）。

テストスイートが終了すると、指定されたディレクトリに自己完結型のHTMLレポートが書き込まれます。コンソールにログ出力されたパスを確認して、レポートファイルを探してください。特定のディレクトリにレポートを書き込むには、 outputPath パラメータを使用して、絶対パスまたは ~で始まるパスを指定します。パスを省略した場合のデフォルトは ~/AxeDevToolsMobileResults です。 nilへお問い合わせください。

@discardableResult
public func generateHtmlReportAndSummary(outputPath: String? = nil) throws -> AxeReportResult

これらのレポートには、スクリーンショットとルールの失敗のみが含まれます。詳細なレポートが必要な場合、ビュー階層、通過または不完全とマークされたルール、ルール失敗の詳細を含む報告書を作成するために、Axe DevTools Reporter CLIを使用するべきです。

結果を使用した詳細レポート

次の Axe DevTools Reporter CLI を利用して、一連のスキャンからHTMLレポートを作成します。また、プログラムを使って結果ファイルにアクセスし、内部報告ツールとアクセシビリティの指標を統合することもできます。

完全な例

func testAccessibility() throws {
    guard let result = try axe?.run(onElement: XCUIApplication()) else { XCTFail(); return }

    //Save Result Locally
    let path = try axe?.saveResult(result)
    print("Result saved to location: \(path)")

    //Any assertions
    XCTAssertEqual(result?.failures.count, 0)
}

クラウドテストプラットフォームでのサポート

結果をローカルに保存すると、クラウドテストプラットフォームでは期待通りに機能しません。クラウドテストプラットフォームのサポートが必要な場合は、 helpdesk@deque.com にリクエストを送信するか、 support.deque.comへお問い合わせください。