Integrate Accessibility testing with App Automate

Learn how to add accessibility checks to your existing functional tests and generate comprehensive reports of accessibility issues.

This feature is currently in Alpha. To get access, contact support.

Integrate your functional test suites with App Accessibility Automate to run accessibility checks on your mobile apps and access detailed accessibility violation reports on the App Accessibility dashboard, ensuring your applications meet accessibility standards.

For Android devices, App Accessibility automation tests are supported on OS version 11 and above.

Prerequisites

You must have a BrowserStack account (a free trial works). Obtain your username and access key from Account & Profile section.
Ensure you have a functional TestNG test suite integrated with BrowserStack Automate.
Install Maven or Gradle on your machine. Set their environment variables and add their bin directories to the system $PATH.
You require the following software versions:
- TestNG v6.8 or higher
- Java v8 or higher (Java 9 or higher is required for Gradle)

Integrate App Accessibility Automate to run accessibility checks

Follow these steps to add automated accessibility checks to your test suite:

Set BrowserStack credentials

Saving your BrowserStack credentials as environment variables makes it easier to run your test suite.

Copy

Install or update your SDK

Install the SDK or update the SDK to the latest version.

The minimum version of browserstack-java-sdk that supports Automated tests is 1.29.0.

Install SDK
Update SDK

Follow these steps to install BrowserStack SDK.

Maven Archetype provides a template to quickly configure your project. Copy & run the below command on your terminal/command prompt to add browserstack-java-sdk dependency in your pom.xml and browserstack.yml config file in your project.

Copy

Follow these steps to update your BrowserStack SDK.

Maven
Gradle

Update your pom.xml file to include the latest version of the BrowserStack SDK:

Copy

Run the following command within your test suite folder from the terminal to update to the latest SDK version:

Copy

Add the SDK dependency in your build.gradle file:

Copy

Run the following command within your test suite folder from the terminal to update to the latest SDK version:

Copy

Modify your browserstack.yml config file

The browserstack.yml file holds all the required capabilities to run your tests on BrowserStack. It is found in your project’s root folder and is part of downloaded sample.

Open browserstack.yml file from your project directory.
Set userName and accessKey parameters in the browserstack.yml file to authenticate your tests on BrowserStack.
Set accessibility capability in the browserstack.yml file.

The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack App Automate since Automated tests will automatically identify different build runs.

Copy

For more information on accessibilityOptions, see Configuration options in Automated tests.

Run your Accessibility checks with Automated tests

Continue running your tests as you have been running previously. The command to run your tests using the BrowserStack SDK remains unchanged. For your reference, here is a sample command:

Copy

After the test completes, access the report in your project folder on the App Accessibility dashboard.

Visit App Accessibility dashboard

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!