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 |
**オプション**: すでに現在の画面のPageSourceを取得している場合、その問い合わせコストを再びかけることなくAxe DevTools Mobileに提供できます。*注: スクリーンショットと結果がダッシュボードで一致していない場合、ページソースが古くなっている可能性があり、それは使用すべきでありません。* |
**設定の必須キー**
| キー | タイプ | 説明 |
|---|---|---|
| apiKey | String |
Dequeによって認可されたユーザーにアクセスを提供するために必要です。AxeアカウントポータルでAxe DevTools Mobile APIキーにアクセスしてください。 |
例
上記で強調された変更の例はこちらです。他のクライアント言語での完全な例はこちら。
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)