[RDC] - Document appium deque integration using the axe devtools for mobile #3013
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| --- | ||
| id: appium-deque-accessibility-testing | ||
|
Check warning on line 2 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| title: Accessibility Testing with Deque axe DevTools® Mobile Drivers | ||
| sidebar_label: Appium Deque axe DevTools Accessibility | ||
| description: Learn how to run accessibility tests using axe DevTools® Mobile Analyzer drivers hosted in Sauce Labs' private cloud. | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| <p><span className="sauceGreen">Real Devices</span></p> | ||
|
|
||
| [Deque's axe™](https://www.deque.com/axe/) is a leading digital accessibility toolkit. | ||
| The [axe DevTools® for Mobile SDK](https://docs.deque.com/devtools-mobile/appium) extends this functionality to mobile platforms, | ||
| enabling automated accessibility testing directly in your Appium workflows for both Android and iOS apps. | ||
| This feature supports compliance with accessibility standards such as WCAG and the European Accessibility Act, | ||
| ensuring your apps are inclusive for all users. | ||
|
|
||
| With this integration, you can: | ||
|
|
||
| + Detect and address accessibility issues early in the development cycle. | ||
| + Automate mobile accessibility testing using Sauce Labs' secure and scalable cloud infrastructure. | ||
| + Gain actionable insights to improve compliance with global accessibility standards. | ||
|
|
||
| The following guide explains how to set up Sauce Labs’ integration with [axe DevTools® for Mobile](https://docs.deque.com/devtools-mobile/appium) | ||
| and leverage its powerful tools to optimize accessibility testing in your mobile apps. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## What You'll Need | ||
|
|
||
| - A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up)) | ||
| - Your Sauce Labs [Username and Access Key](https://app.saucelabs.com/user-settings) | ||
| - Familiarity writing and running [Appium tests](/mobile-apps/automated-testing/appium/) | ||
| - [A Deque Account](https://axe.deque.com/plans) (axe DevTools® for Mobile Product is required) | ||
|
|
||
|
|
||
| ## Appium 2 Version: `appium2-deque-accessibility` | ||
|
|
||
| Sauce Labs offers various versions of Appium 2 in our cloud. One of these is the `appium2-deque-accessibility` version, | ||
| designed to support accessibility testing on mobile apps for both iOS and Android. This version integrates Appium drivers developed by | ||
|
Check warning on line 43 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| the Deque team, enabling seamless integration of accessibility scans into your existing test automation workflows. | ||
|
|
||
| You can find more details on Sauce Labs' [Appium versions documentation](/mobile-apps/automated-testing/appium/appium-versions/#appium-2x). | ||
|
|
||
| ## Key Features of `appium2-deque-accessibility` | ||
|
|
||
| - ****Includes Deque Drivers :**** This version incorporates the following accessibility drivers provided by Deque: | ||
| - axe-appium-uiautomator2-driver: Automation name is `AxeUIAutomator2` | ||
|
Check warning on line 51 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| - axe-appium-xcuitest-driver: Automation name is `AxeXCUITEST` | ||
| :::info Min iOS Version for `axe-appium-xcuitest-driver`: | ||
| - You can use the `axe-appium-xcuitest-driver` only for devices with iOS 17 or above. | ||
|
Check warning on line 54 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| - To ensure compatibility, set the `appium:platformVersion` capability to `'^1(7|8).*$'` in your Appium configuration. | ||
bahrimootaz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ::: | ||
| - ****Backward Compatibility with Deprecated Plugin:**** While Deque’s [axeDevToolsMobile Appium Plugin](https://docs.deque.com/devtools-mobile/2024.2.14/en/june-2024-3) | ||
|
Check warning on line 57 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
bahrimootaz marked this conversation as resolved.
Show resolved
Hide resolved
bahrimootaz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| has been deprecated, Sauce Labs will continue hosting it until January 31st 2025, allowing users time to migrate to the new drivers. | ||
|
|
||
| ## How to Use `appium2-deque-accessibility` | ||
|
Check warning on line 60 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
|
|
||
| Follow these steps to set up and execute accessibility tests using the `appium2-deque-accessibility` image, leveraging Deque's Appium drivers for Android and iOS. | ||
|
Check warning on line 62 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
|
|
||
| 1. Set Up Your Appium Capabilities | ||
|
|
||
| <Tabs | ||
| groupId="appium2-deque-accessibility" | ||
| defaultValue="AxeUIAutomator2" | ||
| values={[ | ||
| {label: 'AxeUIAutomator2', value: 'AxeUIAutomator2'}, | ||
| {label: 'AxeXCUITEST', value: 'AxeXCUITEST'}, | ||
| ]}> | ||
bahrimootaz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <TabItem value="AxeUIAutomator2"> | ||
|
|
||
| <!-- prettier-ignore --> | ||
| ```js | ||
| const capabilities = { | ||
| platformName: 'Android', | ||
| 'appium:platformVersion': '1[0-9]', | ||
| 'appium:automationName': 'AxeUIAutomator2', // New Automation name goes here | ||
|
Check warning on line 81 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| 'appium:app': 'storage:filename=XXXXXXXXXx', | ||
| 'appium:appPackage': 'xxxxxxxxxx', | ||
| 'appium:autoGrantPermissions': true, | ||
| 'appium:autoAcceptAlerts': true, | ||
| 'appium:newCommandTimeout': 90, | ||
| 'sauce:options': { | ||
| name: "Android Driver - Testing appium2-deque-accessibility", | ||
| appiumVersion: 'appium2-deque-accessibility', | ||
| }, | ||
| } | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="AxeXCUITEST"> | ||
|
|
||
| <!-- prettier-ignore --> | ||
| ```js | ||
| const capabilities = { | ||
| platformName: 'iOS', | ||
| 'appium:platformVersion': '^1(7|8).*$', // The iOS driver will work only on devices running iOS 17 and above | ||
| 'appium:automationName': 'AxeXCUITEST', // New Automation name goes here | ||
|
Check warning on line 101 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| 'appium:app': 'storage:filename=XXXXXXXXXx', | ||
| 'appium:appPackage': 'xxxxxxxxxx', | ||
| 'appium:autoGrantPermissions': true, | ||
| 'appium:autoAcceptAlerts': true, | ||
| 'appium:newCommandTimeout': 90, | ||
| 'sauce:options': { | ||
| name: "iOS Driver - Testing appium2-deque-accessibility", | ||
| resigningEnabled: true, | ||
| appiumVersion: 'appium2-deque-accessibility', | ||
| }, | ||
| } | ||
| ``` | ||
| </TabItem> | ||
|
|
||
| </Tabs> | ||
|
|
||
| 2. Obtain Your Deque API Key | ||
| Log in to your [axe Deque account setting page](https://axe.deque.com/settings) and retrieve your API key. | ||
|
Check warning on line 119 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| This key is required to authenticate and initiate accessibility scans during your tests. | ||
|
|
||
| 3. Prepare Your Testing Script | ||
| Once you have your API key, include it in your test script to perform a scan using the `mobile: axeScan` command. Below is an example script: | ||
|
Check warning on line 123 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
|
|
||
| ```js | ||
| describe("Test appium2-deque-accessibility - Using Drivers Android/iOS", () => { | ||
| it('test appium2-deque-accessibility', async () => { | ||
|
Check warning on line 127 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| const apiKey = process.env.DEQUE_API_KEY; | ||
| const settings = { apiKey: apiKey } | ||
|
|
||
| await driver.execute('mobile: axeScan', settings); | ||
| }); | ||
| }); | ||
| ``` | ||
| ## Migrating from the Deprecated Plugin to Deque New Drivers | ||
|
|
||
| Deque's axeDevToolsMobile Appium Plugin is deprecated and will no longer be supported after January 31st 2025. Moving forward, | ||
|
Check warning on line 137 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| the following drivers should be used to ensure compatibility and continued support for accessibility testing: | ||
|
|
||
| - Android: axe-appium-uiautomator2-driver: Automation name is `AxeUIAutomator2` | ||
| - iOS : axe-appium-xcuitest-driver: Automation name is `AxeXCUITEST` | ||
|
Check warning on line 141 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
|
|
||
| ### Why Migrate? | ||
| - Continued Support: The plugin will no longer receive updates, fixes, or enhancements. | ||
| - Expanded Capabilities: The drivers offer better integration and updated functionalities for Android and iOS platforms. | ||
| - Compliance with Modern Requirements: For iOS, the new driver supports devices running iOS 17 and above. | ||
|
|
||
| ### Migration Steps | ||
| 1. ****Update Your Appium Capabilities**** | ||
|
|
||
| Replace the old plugin reference with the appropriate new driver. Choose the correct automationName based on your platform: | ||
|
|
||
| Use `AxeUIAutomator2` for Android. | ||
| Use `AxeXCUITEST` for iOS. | ||
|
|
||
| Additionally, specify the appiumVersion as `appium2-deque-accessibility`. | ||
|
|
||
| ```js | ||
| const capabilities = { | ||
| ..., | ||
| 'appium:automationName': 'AxeUIAutomator2', // For Android; use 'AxeXCUITEST' for iOS | ||
bahrimootaz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ..., | ||
| 'sauce:options': { | ||
| ..., | ||
| appiumVersion: 'appium2-deque-accessibility', | ||
| }, | ||
| }; | ||
| ``` | ||
| 2. ****Update Your Testing Scripts**** | ||
| The `axe:Scan` command used with the ****deprecated**** plugin should now be replaced with the new `mobile: axeScan` command. | ||
|
Check warning on line 170 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
|
|
||
| This command works with the new drivers and requires the same API key setup. | ||
| ```js | ||
| await driver.execute('mobile: axeScan', scanSettings); | ||
| ``` | ||
|
|
||
| ## Additional Notes | ||
|
|
||
| - Ensure your Appium server is correctly set up to use the `appium2-deque-accessibility` version. | ||
|
Check warning on line 179 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| - Validate that your app and environment meet the OS version requirements for the selected Deque drivers. | ||
|
Check warning on line 180 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md
|
||
| - For iOS, remember that the AxeXCUITEST driver only works on devices running iOS 17 or above. | ||
| - The axeDevToolsMobile plugin will remain available in the Sauce Labs cloud until January 31st 2025. | ||
| - Use the Deque [documentation](https://docs.deque.com/devtools-mobile/appium-setup) for further driver-specific details. | ||
Uh oh!
There was an error while loading. Please reload this page.