[RDC] - Document appium deque integration using the axe devtools for mobile

docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md

@@ -0,0 +1,242 @@
+---
+id: appium-deque-accessibility-testing
+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 
+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`
+    - 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. 
+- To ensure compatibility, set the appium:platformVersion capability in your Appium configuration based on the iOS versions 
+supported by the axe-appium-xcuitest-driver. Refer to the [Deque documentation](https://docs.deque.com/devtools-mobile/appium-sauce) 
+for detailed requirements and supported versions.
+:::
+- ****Backward Compatibility with Deprecated Plugin:**** While Deque’s  [axeDevToolsMobile Appium Plugin](https://docs.deque.com/devtools-mobile/2024.2.14/en/june-2024-3) 
+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`
+
+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.
+
+1. Set Up Your Appium Capabilities
+
+<Tabs
+groupId="appium2-deque-accessibility"
+defaultValue="AxeUIAutomator2"
+values={[
+{label: 'AxeUIAutomator2', value: 'AxeUIAutomator2'},
+{label: 'AxeXCUITEST', value: 'AxeXCUITEST'},
+]}>
+
+<TabItem value="AxeUIAutomator2">
+
+<!-- prettier-ignore -->
+```js
+const capabilities = {
+  platformName: 'Android',
+  'appium:platformVersion': '1[0-9]',
+  'appium:automationName': 'AxeUIAutomator2', // New Automation name goes here
+  '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
+  '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. 
+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:
+
+<Tabs
+groupId="appium-deque-2-example"
+defaultValue="TestingScript"
+values={[
+{label: 'Testing Script', value: 'TestingScript'},
+]}>
+
+<TabItem value="TestingScript">
+
+```js
+describe("Test appium2-deque-accessibility - Using Drivers Android/iOS", () => {
+    it('test appium2-deque-accessibility', async () => {
+        const apiKey = process.env.DEQUE_API_KEY;
+        const settings = { apiKey: apiKey }
+
+        await driver.execute('mobile: axeScan', settings);
+    });
+});
+```
+</TabItem>
+
+</Tabs>
+
+## 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, 
+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`
+
+### 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`.
+
+<Tabs
+groupId="appium-deque-accessibility"
+defaultValue="AxeUIAutomator2"
+values={[
+{label: 'AxeUIAutomator2', value: 'AxeUIAutomator2'},
+{label: 'AxeXCUITEST', value: 'AxeXCUITEST'},
+]}>
+
+<TabItem value="AxeUIAutomator2">
+
+<!-- prettier-ignore -->
+```js
+const capabilities = {
+  platformName: 'Android',
+  'appium:platformVersion': '1[0-9]',
+  'appium:automationName': 'AxeUIAutomator2', // New Automation name goes here
+  ...
+  'sauce:options': {
+    ...
+    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
+  ...
+  'sauce:options': {
+    ...
+    appiumVersion: 'appium2-deque-accessibility',
+  },
+}
+```
+</TabItem>
+
+</Tabs>
+
+2. ****Update Your Testing Scripts****
+The `axe:Scan` command used with the ****deprecated**** plugin should now be replaced with the new `mobile: axeScan` command. 
+
+This command works with the new drivers and requires the same API key setup.
+
+<Tabs
+groupId="appium-deque-example"
+defaultValue="TestingScript"
+values={[
+{label: 'Testing Script', value: 'TestingScript'},
+]}>
+
+<TabItem value="TestingScript">
+```js
+await driver.execute('mobile: axeScan', scanSettings);
+```
+</TabItem>
+
+</Tabs>
+
+## Additional Notes
+
+- Ensure your Appium server is correctly set up to use the `appium2-deque-accessibility` version. 
+- Validate that your app and environment meet the OS version requirements for the selected Deque drivers. 
+- 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.

docs/mobile-apps/automated-testing/appium/appium-versions.md

@@ -156,8 +156,8 @@ The current end-of-life strategy outlined above is specific to Real Devices. We
 
 :::info Supported Custom Appium Plugins:
 The following list of custom Appium plugins are supported:
-- [Appium Images Plugin](https://www.npmjs.com/package/@appium/images-plugin). This plugin will now be included by default with Appium version `latest` and all subsequent versions released after April 1st.
-- [Deque axe DevTools® Mobile Analyzer Accessibility plugin](https://docs.deque.com/devtools-mobile/appium). This plugin helps you with automated accessibility testing. Empower your team to focus on identifying and resolving accessibility issues. Requires Deque axe DevTools® Mobile license.
+- [Appium Images Plugin](https://www.npmjs.com/package/@appium/images-plugin). This plugin will now be included by default with Appium version `latest` and all subsequent versions released after April 1st 2024.
+- [Deque axe DevTools® Mobile Analyzer Accessibility plugin](https://docs.deque.com/devtools-mobile/appium). This plugin helps you with automated accessibility testing. Empower your team to focus on identifying and resolving accessibility issues. Requires Deque axe DevTools® Mobile license.  <b>Deprecated</b>
 :::
 
 ### Appium 2.x
@@ -171,7 +171,7 @@ The following list of custom Appium plugins are supported:
     </tr>
   </thead>
   <tbody>
-     <tr>
+    <tr>
       <td>
         <code>stable</code>
       </td>
@@ -260,12 +260,22 @@ The following list of custom Appium plugins are supported:
         <ul>
             <li>
                 <a href="https://docs.deque.com/devtools-mobile/2024.2.14/en/june-2024-3" target="_blank">
-                    <code>axeDevToolsMobile Appium Plugin</code>: 2.2.0
+                    <code>axeDevToolsMobile Appium Plugin</code>: 2.2.0 <b>Deprecated</b>
+                </a>
+            </li>
+            <li>
+                <a href="https://docs.deque.com/devtools-mobile/2024.2.14/en/appium-setup" target="_blank">
+                    <code>axe-appium-xcuitest-driver </code>: 1.0.1
+                </a>
+            </li>
+            <li>
+                <a href="https://docs.deque.com/devtools-mobile/2024.2.14/en/appium-setup" target="_blank">
+                    <code>axe-appium-uiautomator2-driver </code>: 1.1.0
                 </a>
             </li>
             <li>
-                <a href="https://github.com/appium/appium/releases/tag/appium%402.11.0" target="_blank">
-                    <code>appium</code>: 2.11.0
+                <a href="https://github.com/appium/appium/releases/tag/appium%402.12.1" target="_blank">
+                    <code>appium</code>: 2.12.1
                 </a>
             </li>
         </ul>

sidebars.js

@@ -1408,6 +1408,7 @@ module.exports = {
                                 'mobile-apps/automated-testing/appium/test-app-upgrades',
                                 'mobile-apps/automated-testing/appium/appium-flutter',
                                 'mobile-apps/automated-testing/appium/appium-flutter-integration-driver',
+                                'mobile-apps/automated-testing/appium/appium-deque-accessibility-testing',
                             ],
                         },
                         {