Protractor v1

Integrating Percy with your Protractor tests


Covered in this doc

  • Visual regression testing for Protractor
  • Installing @percy/protractor
  • Adding and calling percySnapshot(<snapshotName>, <options>)

Package Status This project is using for visual regression testing.


v1 Documentation

These docs are for version 1.x of @percy/protractor. If you're looking for current documentation, see these docs


If you're not ready to integrate Percy, check out our 2-minute Protractor tutorial and example app with Percy for Protractor already added.

Install @percy/protractor using npm:

npm install --save-dev @percy/protractor

Or using yarn:

yarn add --dev @percy/protractor

In order to start creating snapshots from your Protractor tests, you'll need to import the percySnapshot() function from the @percy/protractor package. You will need to do this in each file from which you want to take snapshots:

const { percySnapshot } = require('@percy/protractor')

You will then use percySnapshot(...) to generate a snapshot:

describe('Integration test with visual testing', function() {
  it('Loads the app', async function() {
    await browser.get('')
    await percySnapshot('My snapshot')

Finally, wrap your script or test runner command in the percy exec command. This will start a Percy agent to receive snapshots from your tests and upload them to your Percy dashboard.

Before you can successfully run Percy, the PERCY_TOKEN environment variable must be set:

# Windows
$ set PERCY_TOKEN=<your token here>

# Unix 
$ export PERCY_TOKEN=<your token here>

Your new test command becomes:

percy exec -- protractor conf.js

Note the double dash with spaces, --, between percy exec and your test run command.

That's it! Now, whenever your tests run with the Percy command, a snapshot of the app in that state will be uploaded to Percy for visual regression testing!

For an example showing how to add Percy snapshots to an existing Protractor test suite, see


Make sure Control Flow is disabled

Our SDK is written using async / await. You will need to disable the WebDriver Control Flow for reliable results. See this issue for more information


percySnapshot(snapshotName, options)

snapshotName is a required string that will be used as the snapshot name. It can be any string that makes sense to you to identify the page state. It should be unique and remain the same across builds. For more details on generating snapshot names, see Autogenerated snapshot names.

options is an optional hash that can include:

  • widths: An array of integers representing the browser widths at which you want to take snapshots.

  • minHeight: An integer specifying the minimum height of the resulting snapshot, in pixels. Defaults to 1024px.

  • percyCSS: A string containing Percy specific CSS that will be applied to this snapshot.

  • requestHeaders: An object containing HTTP headers to be sent for each request made during asset discovery for this snapshot.

For example:

percySnapshot('Homepage test');
percySnapshot('Homepage responsive test', { widths: [768, 992, 1200] });

Global configuration

You can also configure Percy to use the same options over all snapshots. To see supported configuration including widths read our SDK configuration docs