Test iOS Apps for Accessibility

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
Not for use with personal data

Now that you've installed and updated Xcode, verified installation of Xcode Command Line Tools, and installed the Axe DevTools Mobile Analyzer on your Mac, you have everything you need to start running accessibility tests. Follow the steps below to begin scanning your iOS apps.

Launch the App and Sign In

  1. Launch the Axe DevTools Mobile Analyzer application from your Applications folder or Launchpad.
  2. Choose your server configuration before signing in. Your organization administrator can provide this information.
    1. For standard SaaS, choose 'Standard Server.'
    2. For On Prem or Private Cloud choose 'Custom Server,' and enter the backend URL provided by your organization’s administrator.
  3. Select 'Sign In.' A browser window will open.
  4. Log in with your Deque username and password when prompted. Note: If you are already logged in with your Deque username/password on the web, the browser will automatically sign you in to the Mobile Analyzer app. You will not need to enter your username and password.
  5. Return to the Mobile Analyzer app.

Set Up Physical Device Testing

The first time you sign in, the Analyzer checks that your Mac is ready to test on physical devices and walks you through any remaining setup. (On future launches, the app remembers your choices and will take you straight to Ready to Test.)

If you are only testing on a simulator, you can select Use Simulator Instead on any of these screens and skip ahead to the last step - Ready to Test.

  1. Xcode readiness check On launch, the Analyzer confirms that Xcode is installed, that your command line tools point to the full Xcode app (not just the standalone Command Line Tools), and that you have accepted the Xcode license agreement.

  2. Sign in to Xcode with your Apple ID (first-time Xcode users) To test on a physical device, your Mac needs an Apple Developer team and a signing certificate. If you have never used Xcode before, you won't have either of these yet, and the Analyzer shows the Apple ID Required for Physical Devices screen.

    To resolve this issue, sign in to Xcode with your Apple ID. Signing in creates the signing certificate and registers your Apple Developer team on your Mac. The Analyzer detects this automatically and continues on its own.

  3. Select your Apple Developer team On the Set Up Physical Devices screen, choose your Apple Developer team from the dropdown, then select Connect Device. The Analyzer applies the code signing configuration for you.

    • Select your organization's paid team - do not select your Personal Team.
    • If your team isn't listed, make sure you have signed in to Xcode with the Apple ID that belongs to that team.
    • Free (personal) Apple Developer accounts are not supported. If one is selected, you will be prompted to choose a different team.
  4. Ready to Test Once setup is complete, you'll see a screen titled Ready to Test.

Connect your Device

  1. If using a physical device, connect it to your computer via USB.
  2. If prompted, select 'Trust.'
  3. If using a simulator, ensure the simulator is running. Note: Your device or simulator must have access to the internet.
    (Visit axe.deque.com on your device or simulator’s browser to verify your internet connection.)

Time to Scan

  1. Select 'Scan a New App.'

  2. You will be introduced to Projects. If this is your first mobile project, it will be named automatically.

    note

    If you have existing mobile projects in Axe Developer Hub, you are able to select which project you would like to use for results when you start your scanning session. Select the hyperlinked project name on the 'Time to scan' screen to access the project selection screen, and can choose where to send results for the current scan session. You can also navigate to Axe Developer Hub to Create a new project for your results.

    Note: As a best practice, you should have results from automated test runs and mobile scan sessions in separate projects.


  3. Select your device or simulator from the list.

  4. Select your app from the list.

  5. Optional: Provide a name for the scan. The default name will be the screen's title, if one exists.

  6. Ensure your device is awake and the screen you want to scan is visible.

  7. Select 'Scan'.

  8. Enter your keychain password if prompted, and choose 'Always Allow.'

screenshot of modal asking for user to grant permissions by entering their password
  1. If using a physical device, enter your device’s passcode when prompted to start test automation.

screenshot of a numeric keypad on an iphone prompting user to enter a passcode
  1. If using a simulator, allow the WebDriverAgentRunner-Runner.app to accept incoming connections when prompted.

screenshot of modal asking user to accept incoming connections when prompted
  1. Once the scan is finished you can select 'Add Another Scan to the Report'. Navigate to a different screen in your app on your device or simulator, and return to step 5 above.
  2. When you are finished taking scans, select 'Review and finalize report'.

You will see a summary of your scan session. The default report name will use a timestamp. You can select that field to rename your report. If you are ready to look at your results, select the button to 'View report in a new tab'. This will take you to Axe Developer Hub.

Create a New Project in Developer Hub

If you want to create a new project for results rather than saving to an existing one, go to Axe Developer Hub. Select the button to 'Add a new project', and select 'Mobile analyzer' as the integration method. You will see confirmation that your project was created on the next screen. When you return to the Analyzer app, find your new project on the project selection screen.

tip

We recommend keeping results from automated testing and results from the mobile analyzers in separate projects to more accurately track the accessibility health of your apps. If you have been using Axe Developer Hub for results from automated testing with our SDKs and Appium drivers, you may see these as options on the project selection screen. If you don't have an existing project for Analyzer results, you should create a new project.

Finish Testing - Physical Device Only

  • When testing on a physical device, 'Automation Running' will remain on the screen. You can navigate to new screens and take additional scans while it's still running.
  • When you are finished testing, hold both volume buttons to stop automation on your device.

What's Next?

View and manage results in Axe Developer Hub - a central location where you can keep track of the accessibility status of your web and mobile applications.