diff --git a/docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md b/docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md new file mode 100644 index 0000000000..631a15a08d --- /dev/null +++ b/docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md @@ -0,0 +1,46 @@ +--- +id: appium-deque-drivers +title: Deque axe DevTools® Mobile Analyzer Accessibility Drivers +sidebar_label: Appium Deque axe DevTools Integration +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'; + +

Real Devices

+ +[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, +allowing you to integrate automated accessibility testing directly into your Appium workflows. +With this SDK, you can scan mobile app content, identify accessibility issues, and improve compliance with accessibility standards. + +The following guide explains how to set up the Sauce Labs integration with [axe DevTools® for Mobile](https://docs.deque.com/devtools-mobile/appium). +This integration enables you to run mobile accessibility tests securely and efficiently using Sauce Labs' private cloud infrastructure. + +## 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 private 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 developed by Deque: + - [axe-appium-xcuitest-driver](https://docs.deque.com/devtools-mobile/2024.9.18/en/appium-setup#configure-your-tests): Automation name is `AxeXCUITEST` + - [axe-appium-uiautomator2-driver](https://docs.deque.com/devtools-mobile/2024.9.18/en/appium-setup#configure-your-tests): Automation name is `AxeUIAutomator2` +- ****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, allowing users time to migrate to the new drivers. +- ****Powered by Appium :**** This version is built on version [2.12.1](https://github.com/appium/appium/releases/tag/appium%402.12.1) of appium, +ensuring the latest Appium features and compatibility enhancements. + diff --git a/docs/mobile-apps/automated-testing/appium/appium-versions.md b/docs/mobile-apps/automated-testing/appium/appium-versions.md index 8ac028de85..86ded74136 100644 --- a/docs/mobile-apps/automated-testing/appium/appium-versions.md +++ b/docs/mobile-apps/automated-testing/appium/appium-versions.md @@ -157,7 +157,7 @@ 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. +- [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. Deprecated ::: ### Appium 2.x @@ -171,7 +171,7 @@ The following list of custom Appium plugins are supported: - + stable @@ -260,12 +260,22 @@ The following list of custom Appium plugins are supported: diff --git a/sidebars.js b/sidebars.js index 03eb39a547..401284617e 100644 --- a/sidebars.js +++ b/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-drivers', ], }, {