自動スキャン

概要

標準のXCUITestジェスチャーにフックすることで、自動スキャンはテストスイートが操作するすべての画面をキャプチャし、スキャンします。個別のスキャン呼び出し、インポート、またはテストへの修正を追加する必要はありません。

動作の仕組み

1. テストバンドルが開始されると、Auto Scanはaxe_config.jsonを読み込み、インタラクションの監視を開始します
2. サポートされている各インタラクションの後、自動スキャンは現在の画面をキャプチャします
3. テストバンドルが終了すると、Auto Scanは結果を処理し、各画面のJSON結果と要約およびHTMLレポートをAxeDevToolsMobileResults/に保存し、オプションで結果をDeveloper Hubにアップロードします

はじめに

1. axe_config.jsonを作成します:

{
  "axeAutoScanMode": true,
  "axeAppBundleId": "com.example.myapp",
  "axeMobileApiKey": "<API_KEY>",
  "axeProjectId": "<PROJECT_ID>",
  "axeHtmlReportPath": "~/my-custom-report-folder"
}

2. UIテストターゲットバンドルにaxe_config.jsonを追加します（Xcode：Project Navigator > Add Files > チェックしてUIテストターゲット）
3. axe_config.jsonを.gitignoreに追加します
4. テストを通常通りに実行

コード例

以下のスニペットは、Auto Scan固有のコードを含まない標準のXCUITestです：

import XCTest

class MyAppUITests: XCTestCase {
    let app = XCUIApplication()

    override func setUpWithError() throws {
        app.launch()  // triggers initial capture
    }

    func testSettings() throws {
        app.buttons["Settings"].tap()  // triggers capture
    }
}

結果の解釈

コンソール概要

テストスイートが終了すると、次のようなコンソール概要が出力されます：

----  Axe DevTools Mobile Accessibility Summary ----
Scan 1:
  Screen: HomeScreen
  Issues: 3
  Issues by rule:
    - ColorContrast: 2
    - TouchTargetSize: 1

Scan 2:
  Screen: SettingsScreen
  Issues: 0

Total Scans: 2
❌ Total Issues: 3
----------------------------------------------------

クリーンランではコンソールにAxe Clean - 0 Issues Found 🎉が表示されます。

出力ファイル

各テストランの終了時に、Auto Scanはスクリーンショット、影響レベル、詳細な問題情報を含む自己完結型のHTMLレポートを生成します。出力ファイルはaxe_config.jsonで定義できるユーザー構成可能な出力ディレクトリに保存されます。axeHtmlReportPathは絶対パスまたは~プレフィックスが付いたパス（例: ~/my-axe-reports）を受け入れます。未設定の場合、デフォルトの出力ディレクトリは~/AxeDevToolsMobileResultsです。

自動スキャンサポート

ルール

Auto ScanはScreenOrientation、SupportsDynamicType、およびすべての実験的なルールを除いて、Axeルールセット全体を実行します。確認する項目に関する詳細情報はiOSのルール概要で確認してください。

Developer Hub

Auto Scanは自動的に結果をAxe Developer Hubにアップロードします。結果をローカルに保存するのみの場合は、axeUploadResultsをfalseに設定します。

構成リファレンス

プロパティ

ベストプラクティス

アニメーションを無効化

アニメーションを無効にすることで、Auto Scan から最も正確で包括的な結果を得ることができます。これにより、画面がキャプチャ時に完全に描画されることを確保します。

以下の 2 つの要素が必要です：

テストのセットアップ：

override func setUpWithError() throws {
    let app = XCUIApplication()
    app.launchArguments.append("-DisableAnimations")
    app.launch()
}

アプリの起動パス（AppDelegate または @main）：

if ProcessInfo.processInfo.arguments.contains("-DisableAnimations") {
    UIView.setAnimationsEnabled(false)
}

起動引数はフラグをアプリのプロセスに渡します。アプリ側のチェックがそれに作用します。どちらも単独では機能しません。

注意: UIView.setAnimationsEnabled(false)はSwiftUIネイティブアニメーション（withAnimation {}）をカバーしていません。SwiftUIアプリは追加の処理が必要になるかもしれません。

トラブルシューティング

• 結果がない？ UIテストターゲットバンドルにaxe_config.jsonが含まれているか確認します。XCodeのFile Inspectorでターゲットメンバーシップを確認します。
• ローカルで結果が見えても、Developer Hubで見えませんか？ もし結果ファイルのサイズが20MBを超えると、Developer Hubへのアップロードが失敗しますが、すべての結果はローカルに保存され、ローカルHTMLレポートで表示されます。
• ログを確認してください。 コンソールでAutoScanメッセージを探します。

次にやるべきことは？

結果はAxe Developer Hubで確認できます。Axe DevTools MobileをあなたのCI/CDパイプラインに統合する方法について学ぶ方法を学んでください。クラウドベースのテストプラットフォームを使用していますか？Axe DevTools Mobileを使用してアクセシビリティの問題を見つけることができます: クラウドプラットフォームと統合する。