Skip to main content

Accessibility Automation on Jest

Quick start guide to integrate BrowserStack Accessibility Automation with Jest

Pre-requisites

  • You have an account with BrowserStack (even free trial works) and can get the username and access key from Account & Profile.
  • You have a pre-existing Jest based test suite.

Integrate with Accessibility Automation

Follow the steps below to get started with adding Accessibility Automation to your test suite:

Install the latest version of the BrowserStack SDK

Install (or update) the browserstack-node-sdk npm package as shown below:

BrowserStack SDK is a very powerful tool which you can use to set the different browser/device combinations and parallelization. For more details, check out the Automate Integration guide.

Terminal
Copy icon Copy snippet

Make changes to the SDK config file

If you’ve installed the browserstack-node-sdk for the first time, you’ll have to create the browserstack.yml file shown below. Else, just verify that your config file has all the required key-value pairs.

Specifically, make sure to add the accessibility flag at the end of the browserstack.yml file.

Create the browserstack.yml file in the root folder of your test suite if it doesn’t exist.

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 Automate since Accessibility Automation will automatically identify different build runs.

browserstack.yml
Copy icon Copy snippet

Accessibility testing will only run on Desktops (Mac & Windows) with Chrome 95 & above on Automate.

Run your suite with BrowserStack Accessibility Automation

Prepend browserstack-node-sdk to the existing command that you use to trigger a run as shown below and data will automatically start getting sent to BrowserStack Accessibility Automation.

Terminal
Copy icon Copy snippet

You can check the Accessibility report for your build through the Accessibility Automation dashboard.

Visit Accessibility Automation Dashboard

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






Thank you for your valuable feedback

Is this page helping you?

Yes
No

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






Thank you for your valuable feedback!

Talk to an Expert
Download Copy