Migrieren Sie das Appium-Plugin auf 2.0.0
Anleitung zur Migration von Early Adopters zu den neuesten Änderungen von axe DevTools Mobile für Appium.
Hinweis: Wenn Sie gerade erst mit axe DevTools Mobile für Appium beginnen, gehen Sie zum Setup-Handbuch.
Danke für das Feedback! Wir haben einige Änderungen an unserem Appium-Plugin vorgenommen, um Ihnen einen besseren Service zu bieten und die Art und Weise zu verbessern, wie Sie heute mobile Apps testen. Wenn Sie Version 1.0.0 des Appium-Plugin implementiert haben, folgen Sie dieser Anleitung für die einfache Umstellung auf 2.0.0.
Update auf Version 2.0.0
Deinstallieren Sie axeDevToolsMobile:
appium plugin uninstall axeDevToolsMobile
Bei einer Neuinstallation des Plugins wird die neueste Version abgerufen. Installieren Sie das Plugin über die Befehlszeile in Ihrer Appium-Instanz:
appium plugin install --source=npm @axe-devtools/appium-plugin
Fähigkeiten aktualisieren
Kopieren Sie aus Ihren Appium-Automatisierungsskripten die „Schlüssel“-Fähigkeit, die zuvor für den API-Schlüssel von axe DevTools Mobile erforderlich war, und entfernen Sie sie.
Der API-Schlüssel wird in ein Einstellungsobjekt verschoben, um an die executeScript
Methode von Appium übergeben zu werden.
Sie könnten in Betracht ziehen, Ihrem Testskript eine Hilfsfunktion als zentralen Ort zum Initiieren eines Zugänglichkeitsscans hinzuzufügen.
So aktualisieren Sie das Scannen nach Barrierefreiheitsproblemen
Zuvor hat das Plug-In die Seitenquellenmethode von Appium abgefangen, um nach Zugänglichkeitsproblemen zu suchen. Dies wurde so geändert, dass die Seitenquelle weiterhin wie bisher in Tests verwendet werden kann!
Überall, wo Sie einen Zugänglichkeitstest starten möchten, ersetzen Sie Aufrufe der Seitenquellen-API durch ExecuteScript-API.
executeScript("axe:scan", Settings)
Param | Art | Beschreibung |
---|---|---|
Einstellungen | Object |
Enthält die erforderlichen Konfigurationen für axe DevTools Mobile. (Siehe Erforderliche Schlüssel in den Einstellungen). |
Seitenquelle | String |
Optional: Wenn Sie die PageSource für den aktuellen Bildschirm bereits erfasst haben, können Sie sie an axe DevTools Mobile weitergeben, ohne dass die Abfragekosten erneut anfallen. Hinweis: Wenn Sie feststellen, dass der Screenshot und die Ergebnisse im Dashboard nicht übereinstimmen, ist die PageSource möglicherweise veraltet und sollte nicht verwendet werden. |
Erforderliche Schlüssel in den Einstellungen
Taste | Art | Beschreibung |
---|---|---|
apiKey | String |
Von Deque benötigt, um autorisierten Benutzern Zugriff zu gewähren. Greifen Sie im axe-Konto Portal auf Ihren axe DevTools Mobile API-Schlüssel zu. |
Beispiele
Hier ist ein Beispiel der oben hervorgehobenen Änderungen. Vollständige Beispiele sind in anderen Clientsprachen verfügbar.
Beispiel in Python
def runAccessibilityScan(self):
settings = {}
settings['apiKey'] = "<your-api-key-here>"
return self.driver.execute_script('axe:scan', settings)
Beispiel mit PageSource in Python
def runAccessibilityScan(self):
settings = {}
settings['apiKey'] = "<your-api-key-here>"
pageSource = self.driver.page_source
return self.driver.execute_script('axe:scan', settings, pageSource)