Auto Scan

Overzicht

Door aansluiting op standaard XCUITest-gebaren, legt Auto Scan elke scherm vast waarmee uw testsuite interageert, zonder dat u individuele scanoproepen, imports of wijzigingen aan uw tests hoeft toe te voegen.

Hoe het werkt

1. Wanneer de testbundel start, laadt Auto Scan axe_config.json en begint het interacties te observeren
2. Na elke ondersteunde interactie legt Auto Scan het huidige scherm vast
3. Wanneer de testbundel voltooid is, verwerkt Auto Scan uw resultaten, slaat een JSON-resultaat voor elk scherm op - samen met een samenvatting en een HTML-rapport - naar AxeDevToolsMobileResults/, en uploadt optioneel resultaten naar Developer Hub

Aan de slag

1. Maak axe_config.json:

{
  "axeAutoScanMode": true,
  "axeAppBundleId": "com.example.myapp",
  "axeMobileApiKey": "<API_KEY>",
  "axeProjectId": "<PROJECT_ID>"
}

2. Voeg toe axe_config.json aan de UI-testdoelbundel in Xcode (Project Navigator > Voeg bestanden toe > Vink de UI-testdoel aan)
3. Voeg toe axe_config.json aan .gitignore
4. Voer tests normaal uit

Voorbeeldcode

Het onderstaande codefragment is een standaard XCUITest, zonder Auto Scan-specifieke code:

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
    }
}

Resultaten interpreteren

Consolesamenvatting

Een consolesamenvatting vergelijkbaar met de volgende wordt afgedrukt wanneer de testsuite is voltooid:

----  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
----------------------------------------------------

Een schone run zal Axe Clean - 0 Issues Found 🎉 in de console tonen.

Uitvoerbestanden

Auto Scan genereert enkele verschillende bestanden aan het einde van elke testuitvoering, inclusief een zelfvoorzienend HTML-rapport dat schermafbeeldingen, weergave-hiërarchiegegevens en gedetailleerde probleeminformatie bevat. Alle bestanden worden opgeslagen in de AxeDevToolsResults directory.

Auto Scan Ondersteuning

Regels

Auto Scan draait de volledige Axe-regelset met uitzondering van ScreenOrientation, SupportsDynamicType, en alle experimentele regels. Vind gedetailleerde informatie over wat we controleren in de Regeloverzicht voor iOS.

Developer Hub

Auto Scan uploadt automatisch uw resultaten naar Axe Developer Hub. Als u resultaten alleen lokaal wilt opslaan, stel axeUploadResults in op false.

Configuratiereferentie

Eigenschappen

Beste praktijken

Animaties uitschakelen

Krijg de meest accurate en uitgebreide resultaten van Automatische Scan door animatie uit te schakelen. Dit zorgt ervoor dat schermen volledig worden gerenderd wanneer ze vastgelegd worden.

De onderstaande onderdelen zijn vereist:

Test setup:

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

App-lanceringspad (AppDelegate of @main):

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

Het lanceringsargument geeft de vlag door aan het app-proces. De app-zijde controle voert het uit. Geen van beide werkt alleen.

Opmerking: UIView.setAnimationsEnabled(false) dekt geen SwiftUI-native animaties (withAnimation {}). SwiftUI-apps hebben mogelijk extra behandeling nodig.

Probleemoplossing

• Geen resultaten? Controleer of axe_config.json is opgenomen in de UI-testdoelbundel. Controleer Doel lidmaatschap in het Bestandsinspecteur van XCode.
• Resultaten lokaal te zien, maar niet in Developer Hub? Het uploaden naar Developer Hub mislukt als de grootte van een resultaatbestand groter is dan 20MB, maar alle resultaten worden nog steeds lokaal opgeslagen en getoond in het lokale HTML-rapport.
• Controleer logbestanden. Zoek naar AutoScan berichten in de console.

Wat Nu?

Je kunt je resultaten bekijken in Axe Developer Hub. Leer hoe je Axe DevTools Mobile integreert in je CI/CD-pijplijn. Gebruik je een cloudgebaseerd testplatform? Je kunt Axe DevTools Mobile nog steeds gebruiken om te zoeken naar toegankelijkheidsproblemen: Integreren met Cloudplatforms.