Skip to content

Commit

Permalink
Document appium deque integration using the axe devtools for mobile
Browse files Browse the repository at this point in the history
  • Loading branch information
bahrimootaz committed Nov 18, 2024
1 parent d6e3917 commit cd2fdbc
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: appium-deque-drivers

Check warning on line 2 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md#L2

[sauce.WordList] Use 'Appium' instead of 'appium'.
Raw output
{"message": "[sauce.WordList] Use 'Appium' instead of 'appium'.", "location": {"path": "docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md", "range": {"start": {"line": 2, "column": 5}}}, "severity": "WARNING"}
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';

<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,
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

Check warning on line 33 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md#L33

[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md", "range": {"start": {"line": 33, "column": 135}}}, "severity": "WARNING"}
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).

Check warning on line 36 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md#L36

[sauce.WordList] Use 'Appium' instead of 'appium'.
Raw output
{"message": "[sauce.WordList] Use 'Appium' instead of 'appium'.", "location": {"path": "docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md", "range": {"start": {"line": 36, "column": 105}}}, "severity": "WARNING"}

## 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)

Check warning on line 42 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md#L42

[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md", "range": {"start": {"line": 42, "column": 171}}}, "severity": "WARNING"}
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,

Check warning on line 44 in docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md#L44

[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md", "range": {"start": {"line": 44, "column": 146}}}, "severity": "WARNING"}
ensuring the latest Appium features and compatibility enhancements.

20 changes: 15 additions & 5 deletions docs/mobile-apps/automated-testing/appium/appium-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. <b>Deprecated</b>
:::

### Appium 2.x
Expand All @@ -171,7 +171,7 @@ The following list of custom Appium plugins are supported:
</tr>
</thead>
<tbody>
<tr>
<tr>
<td>
<code>stable</code>
</td>
Expand Down Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
],
},
{
Expand Down

0 comments on commit cd2fdbc

Please sign in to comment.