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 19, 2024
1 parent 7f095cd commit 6c7e3e7
Showing 1 changed file with 54 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ You can find more details on Sauce Labs' [Appium versions documentation](/mobile
- 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 to `'^1(7|8).*$'` in your Appium configuration.
- To ensure compatibility, set the appium:platformVersion capability in your Appium configuration based on the iOS versions

Check warning on line 55 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#L55

[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": 55, "column": 124}}}, "severity": "WARNING"}
supported by the axe-appium-xcuitest-driver. Refer to the [Deque documentation](https://docs.deque.com/devtools-mobile/appium-sauce)

Check warning on line 56 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#L56

[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": 56, "column": 133}}}, "severity": "WARNING"}
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)

Check warning on line 59 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#L59

[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": 59, "column": 171}}}, "severity": "WARNING"}
has been deprecated, Sauce Labs will continue hosting it until January 31st 2025, allowing users time to migrate to the new drivers.
Expand Down Expand Up @@ -150,29 +152,73 @@ the following drivers should be used to ensure compatibility and continued suppo

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.
+ 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

Check warning on line 175 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#L175

[sauce.MeaningfulLinkWords] Improve SEO and accessibility by rewriting 'here' in the link text.
Raw output
{"message": "[sauce.MeaningfulLinkWords] Improve SEO and accessibility by rewriting 'here' in the link text.", "location": {"path": "docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md", "range": {"start": {"line": 175, "column": 75}}}, "severity": "WARNING"}
...
'sauce:options': {
...
appiumVersion: 'appium2-deque-accessibility',
},
}
```
</TabItem>
<TabItem value="AxeXCUITEST">

<!-- prettier-ignore -->
```js
const capabilities = {
...,
'appium:automationName': 'AxeUIAutomator2', // For Android; use 'AxeXCUITEST' for iOS
...,
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 191 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#L191

[sauce.MeaningfulLinkWords] Improve SEO and accessibility by rewriting 'here' in the link text.
Raw output
{"message": "[sauce.MeaningfulLinkWords] Improve SEO and accessibility by rewriting 'here' in the link text.", "location": {"path": "docs/mobile-apps/automated-testing/appium/appium-2-deque-drivers.md", "range": {"start": {"line": 191, "column": 71}}}, "severity": "WARNING"}
...
'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.

Check warning on line 204 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#L204

[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": 204, "column": 126}}}, "severity": "WARNING"}

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

Expand Down

0 comments on commit 6c7e3e7

Please sign in to comment.