Appium Testing on Sauce Labs

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Quickly identify accessibility issues in your iOS or Android applications with Appium testing, now supported on Sauce Labs!

Not for use with personal data

Test for accessibility with Appium and Sauce Labs

Deque has partnered with Sauce Labs to bring accessibility testing to your existing testing infrastructure. Add accessibility scans to your Appium tests with axe DevTools Mobile, run your tests on real devices with Sauce Labs, then check out the results in our online axe DevTools Mobile Dashboard.

Setup for Accessibility Scans

Prerequisites:

  • Your tests running against Appium version 2.0 or above
  • API Key for axe DevTools Mobile
  • Use of UiAutomator2 or XCUITest Driver

Sauce Labs has taken care of the Appium integration for you. To initiate accessibility testing, you'll need to incorporate accessibility scans into your existing Appium tests. Refer to our setup guide, beginning with the section titled "Scan for Accessibility Issues".

Setup for Running Tests on Sauce Labs

Prerequisites:
  • A Sauce Labs account: Username and Access Key
  • Application uploaded to Sauce Labs App Storage: Script available
  • Sauce Labs custom Appium version: appium2-deque-accessibility

  • Required Capabilities:

    Name Type Description
    appium:app String The location of the app under test. Set storage:filename={filename of your app} to access apps uploaded to Sauce Labs. iOS apps use the file format .ipa and Android use .apk
    appium:automationName String The name of the automation engine. Set to: axexcuitest for iOS or axeuiautomator2 for Android
    sauce:options Object Details on Sauce Labs account and configuration options.

    sauce:options Object

    Name Type Description
    username String Sauce Labs Username
    accessKey String Sauce Labs Access Key
    build String An identifier for your test run, displayed in Sauce Labs Dashboard
    name String Your test name
    appiumVersion String Set to: appium2-deque-accessibility

    NOTE: The XCUITest driver currently supports Sauce Labs devices running iOS 16+.

    Lastly, update your driver URL to connect to Sauce Labs! Example: self.driver = webdriver.Remote('https://ondemand.us-west-1.saucelabs.com:443/wd/hub', options=options)

    Helpful reference:

  • Quick start with Appium on Sauce Labs
  • Run Your Tests

    Now you can run your Appium tests on Sauce Labs and scan for accessibility. Check out your accessibility results on the axe DevTools Mobile dashboard at axe-mobile.deque.com.

    Need help?

  • Contact Sauce Labs Support at support.saucelabs.com
  • Contact Deque Support at support.deque.com