Appium-Plugin auf Version 2.0.0 migrieren
Leitfaden für frühe Anwender, um auf die neuesten Änderungen von Axe DevTools Mobile für Appium umzusteigen.
Hinweis: Wenn Sie erst mit Axe DevTools Mobile für Appium beginnen, gehen Sie zur Einrichtungsanleitung.
Danke für das Feedback! Wir haben einige Änderungen an unserem Appium-Plugin vorgenommen, um Sie besser zu unterstützen, wie Sie heutzutage mobile Apps testen. Wenn Sie die Version 1.0.0 des Appium-Plugins implementiert haben, folgen Sie diesem Leitfaden für einfache Schritte beim Wechsel auf Version 2.0.0.
Aktualisierung auf Version 2.0.0
axeDevToolsMobile deinstallieren:
appium plugin uninstall axeDevToolsMobileEine Neuinstallation des Plugins wird die neueste Version holen. Installieren Sie das Plugin über die Befehlszeile in Ihrer Appium-Instanz:
appium plugin install --source=npm @axe-devtools/appium-pluginAktualisieren der Fähigkeiten
Kopieren Sie aus Ihren Appium-Automatisierungsskripten die zuvor für den API-Schlüssel von Axe DevTools Mobile benötigte 'key'-Fähigkeit und entfernen Sie sie dann.
Der API-Schlüssel wird in ein Einstellungsobjekt verschoben, das an Appiums executeScript Methode übergeben wird.
Sie könnten erwägen, eine Hilfsfunktion zu Ihrem Testskript hinzuzufügen, die als zentraler Ort zum Starten eines Barrierefreiheitsscans dient.
So aktualisieren Sie den Scan nach Barrierefreiheitsproblemen
Bisher hat das Plugin die Seitenquellenmethode von Appium abgefangen, um auf Barrierefreiheitsprobleme zu prüfen. Dies wurde ersetzt, sodass die Seitenquelle weiterhin wie zuvor in Tests verwendet werden kann!
Überall, wo Sie einen Barrierefreiheitstest starten möchten, ersetzen Sie die Aufrufe der Seitenquellen-API durch execute script API.
executeScript("axe:scan", Settings)
| Parameter | Typ | Beschreibung |
|---|---|---|
| Einstellungen | Object |
Enthält die erforderlichen Konfigurationen für Axe DevTools Mobile. (Siehe Erforderliche Schlüssel in den Einstellungen). |
| PageSource | String |
Optional: Wenn Sie die PageSource für den aktuellen Bildschirm bereits abgerufen haben, können Sie sie Axe DevTools Mobile bereitstellen, ohne erneut die Kosten für diese Abfrage zu verursachen. Hinweis: Wenn Sie feststellen, dass der Screenshot und die Ergebnisse im Dashboard nicht übereinstimmen, kann es sein, dass die PageSource veraltet ist und nicht verwendet werden sollte. |
Erforderliche Schlüssel in den Einstellungen
| Schlüssel | Typ | Beschreibung |
|---|---|---|
| apiKey | String |
Von Deque benötigt, um autorisierten Benutzern Zugriff zu gewähren. Greifen Sie auf Ihren Axe DevTools Mobile API-Key im Axe-Konto Portal zu. |
Beispiele
Hier ist ein Beispiel für die oben hervorgehobenen Änderungen. Vollständige Beispiele sind in anderen Programmiersprachen 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)