Appiumプラグインを2.0.0に移行する
axe DevTools Mobile for Appiumの最新の変更に早期導入者を移行するためのガイド。
注: axe DevTools Mobile for Appiumを始めたばかりの場合は、 セットアップガイドに進んでください。
フィードバックをありがとうございます!モバイルアプリのテストを行う際により良いサポートを提供するために、Appiumプラグインにいくつかの変更を加えました。Appiumプラグインのバージョン1.0.0を実装している場合は、このガイドに従って簡単な手順で2.0.0に切り替えてください。
バージョン2.0.0への更新
axeDevToolsMobileのアンインストール:
appium plugin uninstall axeDevToolsMobileプラグインの新規インストールにより、最新バージョンを取得できます。コマンドラインを通じてAppiumインスタンスにプラグインをインストールします:
appium plugin install --source=npm @axe-devtools/appium-plugin機能の更新
Appium自動化スクリプトから、axe DevTools MobileのAPIキーに以前必要だった「key」機能をコピーして削除します。
APIキーは、Appiumの executeScript メソッドに渡される設定オブジェクトに移されます。
アクセシビリティスキャンを開始する中央の場所として、テストスクリプトにユーティリティ関数を追加することを検討してもよいでしょう。
アクセシビリティ問題のスキャン方法の更新
以前は、プラグインがAppiumのページソースメソッドをインターセプトしてアクセシビリティ問題をチェックしていました。これが置き換えられたので、これまで通りにテストでページソースを使用できます!
アクセシビリティテストを開始したい場所では、 ページソースAPI を スクリプト実行APIに置き換えます。
executeScript("axe:scan", 設定)
| パラメータ | タイプ | 説明 |
|---|---|---|
| 設定 | Object |
axe DevTools Mobileに必要な構成を含みます。(設定の必須キーを参照)。 |
| ページソース | String |
**オプション**: すでに現在の画面のページソースを取得している場合は、そのクエリコストを繰り返すことなくaxe DevTools Mobileに提供できます。 *注: スクリーンショットと結果がダッシュボードで一致していない場合、ページソースが古くなっている可能性があり、それは使用すべきでありません。* |
**設定の必須キー**
| キー | タイプ | 説明 |
|---|---|---|
| apiKey | String |
Dequeが認証済みユーザーへのアクセスを提供するために必要です。axe DevTools Mobile APIキーは axeアカウント ポータルでアクセスできます。 |
例
上述の変更点の例を以下に示します。 他のクライアント言語での完全な例はこちらをご覧ください。
Pythonでの例
def runAccessibilityScan(self):
settings = {}
settings['apiKey'] = "<your-api-key-here>"
return self.driver.execute_script('axe:scan', settings)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)