Skip to main content
🎉 A11y Issue Detection Agent is now live! Detect accessibility issues like a WCAG expert with AI. Try now!
No Result Found
Get your setup working faster. Join our Discord for optimisation tips from elite testers. Join our DiscordJoin our Discord

Automated tests on Puppeteer

Quick start guide to integrate Automated tests on BrowserStack Accessibility Testing with Puppeteer.

Prerequisites

  • You have an account with BrowserStack (even a free trial works) and can get the username and access key from Account & Profile.
  • You have an existing Puppeteer test suite using Jest as the test runner.
  • Node.js 14 or later and npm installed.

Integrate with Automated tests

Follow these steps to get started with adding Automated tests to your test suite:

The minimum version of browserstack-node-sdk that supports Automated tests is 1.51.0.

Set your BrowserStack credentials as environment variables

Set your BrowserStack credentials as environment variables using the following command.

Terminal
Copy icon Copy

Install the latest version of the BrowserStack SDK

Install (or update) the browserstack-node-sdk npm package using the following command.

Terminal
Copy icon Copy

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

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 following browserstack.yml file. Else, verify that your config file has all the required key-value pairs.

Especially, ensure you 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 deviates from the standard BrowserStack Automate approach, because Automated tests automatically identify different build runs.

browserstack.yml
Copy icon Copy
  • Accessibility testing runs on Desktops (Mac & Windows) with Chrome 100 & later on Automate.

Run your suite with Automated tests

Run your test suite using the BrowserStack Node SDK. Prefix your existing Jest command with npx browserstack-node-sdk:

Terminal
Copy icon Copy


You can check the Accessibility report for your build through the Automated tests page.


Visit Automated tests page

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 Check Circle