スキャンを実行する
Not for use with personal data
準備、設定、スキャン開始
Appiumサーバーが稼働し、テスト設定が完了したら、モバイルアプリのスキャンを開始する準備が整いました。
アクセシビリティスキャンは、テストの任意の時点で起動できます。アクセシビリティスキャンを開始する準備ができたら、Execute Script APIを呼び出し、axeScanとsettingsオブジェクトを渡してください。
driver.execute('mobile: axeScan', settings)入力
| パラメータ | タイプ | 説明 |
|---|---|---|
| 設定 | Object |
Axe DevTools Mobileの認証と設定が含まれます。(必要なキーはSettingsのAuthentication Keysを参照してください)。 |
設定内の認証キー
セッションを初期化していない場合していない場合、スキャンを認証するためにsettingsオブジェクトに以下のいずれかを提供する必要があります。
| キー | タイプ | 説明 |
|---|---|---|
| apiKey | String |
Dequeから承認されたユーザーにアクセスを提供するために必要です。AxeアカウントポータルであなたのAxe DevTools Mobile APIキーにアクセスしてください。 |
| licenseKey | String |
Dequeからオフラインスキャン用の承認されたユーザーにアクセスを提供するために必要です。ライセンスキーの提供について調整するために、あなたのDeque担当者またはサポートに連絡に連絡してください。 |
設定内の構成キー
テスト設定をカスタマイズしたい場合は、以下のオプションキーをsettingsオブジェクトに追加できます。これらのプロパティの詳細は設定をカスタマイズするで確認できます。
| キー | タイプ | 説明 |
|---|---|---|
| scanName | String |
ダッシュボード内のスキャンを識別しやすくするためのカスタマイズされたスキャン名を指定します。 |
| tags | [String] |
スキャンに適用する文字列配列を提供します。重要なスキャンを見つけてグループ化するのに役立つタグを使用することをお勧めします。タグ付けされたスキャンは他のチームメンバーにも利用可能です。 |
| ignoreRules | [String] |
すべてのビューで無視するルールのリストを適用するために、文字列の配列を提供します。配列の各文字列は、有効なruleIdである必要があります - 例えば、ColorContrast。任意のスキャンのJSON結果のaxeConfオブジェクト内にruleIdが見つかります。 |
| ignoreExperimental | Boolean |
このパラメータをtrueに設定すると、試験的なルールが無視されます。デフォルト値はfalseです。 |
| uploadToDashboard | Boolean |
このパラメータをfalseに設定すると、スキャンはアップロードされません。デフォルト値はtrueです。 |
tip
アクセシビリティスキャンを開始するための中央の場所として、テストスクリプトにユーティリティ関数を追加することを検討してください。
