Migrer le plugin Appium vers 2.0.0
Guide pour migrer les premiers utilisateurs vers les dernières modifications d'Axe DevTools Mobile pour Appium.
Remarque : Si vous débutez avec Axe DevTools Mobile pour Appium, consultez le guide d'installation.
Merci pour vos retours ! Nous avons apporté quelques modifications à notre plugin Appium pour mieux vous servir et pour s'adapter à la façon dont vous testez vos applications mobiles aujourd'hui. Si vous avez implémenté la version 1.0.0 du plugin Appium, suivez ce guide pour connaître les étapes simples de mise à niveau vers la version 2.0.0.
Mise à jour vers la version 2.0.0
Désinstaller axeDevToolsMobile :
appium plugin uninstall axeDevToolsMobileUne nouvelle installation du plugin vous permettra d'obtenir la version la plus récente. Installez le plugin dans votre instance Appium via la ligne de commande :
appium plugin install --source=npm @axe-devtools/appium-pluginMettre à jour les capacités
Depuis vos scripts d'automatisation Appium, copiez puis retirez la capacité 'key' précédemment requise pour la clé API d'Axe DevTools Mobile.
La clé API sera déplacée vers un objet de paramètres à transmettre à la méthode executeScript d'Appium.
Vous pouvez envisager d'ajouter une fonction utilitaire à votre script de test comme point central pour lancer un scan d'accessibilité.
Mettre à jour la façon de détecter les problèmes d'accessibilité
Auparavant, le plugin interceptait la méthode de source de page d'Appium pour vérifier les problèmes d'accessibilité. Cela a été remplacé afin que la source de page soit toujours disponible pour être utilisée dans les tests, comme vous l'avez fait auparavant !
Partout où vous souhaitez initier un test d'accessibilité, remplacez les appels à API de source de page par API d'exécution de script.
executeScript("axe:scan", Settings)
| Paramètre | Type | Description |
|---|---|---|
| Paramètres | Object |
Inclut les configurations requises pour Axe DevTools Mobile. (Voir Clés Requises dans les Paramètres). |
| SourceDePage | String |
Optionnel : Si vous avez déjà récupéré la SourceDePage pour l'écran actuel, vous pouvez la fournir à Axe DevTools Mobile sans encourir à nouveau ce coût de requête. Remarque : Si vous constatez que la capture d'écran et les résultats ne correspondent pas dans le tableau de bord, la SourceDePage peut être obsolète et ne devrait pas être utilisée. |
Clés Requises dans les Paramètres
| Clé | Type | Description |
|---|---|---|
| apiKey | String |
Requis par Deque pour fournir un accès aux utilisateurs autorisés. Accédez à votre clé API Axe DevTools Mobile dans le portail Compte Axe. |
Exemples
Voici un exemple des modifications soulignées ci-dessus. Des exemples complets sont disponibles dans d'autres langues clientes.
Exemple en Python
def runAccessibilityScan(self):
settings = {}
settings['apiKey'] = "<your-api-key-here>"
return self.driver.execute_script('axe:scan', settings)Exemple avec SourceDePage en 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)