https://github.com/percy/percy-testcafe
TestCafe client library for visual regression testing with Percy
https://github.com/percy/percy-testcafe
percy percy-sdk testcafe visual-testing
Last synced: 6 months ago
JSON representation
TestCafe client library for visual regression testing with Percy
- Host: GitHub
- URL: https://github.com/percy/percy-testcafe
- Owner: percy
- License: mit
- Created: 2019-07-25T15:46:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-30T15:31:57.000Z (6 months ago)
- Last Synced: 2025-07-03T12:57:24.056Z (6 months ago)
- Topics: percy, percy-sdk, testcafe, visual-testing
- Language: JavaScript
- Homepage: https://docs.percy.io/docs/testcafe
- Size: 892 KB
- Stars: 8
- Watchers: 9
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# @percy/testcafe
[](https://www.npmjs.com/package/@percy/testcafe)
[Percy](https://percy.io) visual testing for
[TestCafe](https://www.devexpress.com/products/testcafestudio/).
## Installation
```sh-session
$ npm install --save-dev @percy/cli @percy/testcafe
```
## Usage
This is an example test using the `percySnapshot` function.
```javascript
import percySnapshot from '@percy/testcafe';
fixture('MyFixture')
.page('http://devexpress.github.io/testcafe/example');
test('Test1', async t => {
await t.typeText('#developer-name', 'John Doe');
await percySnapshot(t, 'TestCafe Example');
});
```
Running the test above normally will result in the following log:
```sh-session
[percy] Percy is not running, disabling snapshots
```
When running with [`percy
exec`](https://github.com/percy/cli/tree/master/packages/cli-exec#percy-exec), and your project's
`PERCY_TOKEN`, a new Percy build will be created and snapshots will be uploaded to your project.
```sh-session
$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- testcafe chrome:headless tests
[percy] Percy has started!
[percy] Created build #1: https://percy.io/[your-project]
[percy] Running "testcafe chrome:headless tests"
Running tests in:
- Chrome ...
MyFixture
[percy] Snapshot taken "TestCafe Example"
✓ Test1
1 passed (1s)
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!
```
## Configuration
`percySnapshot(t, name[, options])`
- `t`(**required**) - The test controller instance passed from `test`
- `name` (**required**) - The snapshot name; must be unique to each snapshot
- `options` - [See per-snapshot configuration options](https://www.browserstack.com/docs/percy/take-percy-snapshots/overview#per-snapshot-configuration)
## Upgrading
### Automatically with `@percy/migrate`
We built a tool to help automate migrating to the new CLI toolchain! Migrating
can be done by running the following commands and following the prompts:
``` shell
$ npx @percy/migrate
? Are you currently using @percy/testcafe? Yes
? Install @percy/cli (required to run percy)? Yes
? Migrate Percy config file? Yes
? Upgrade SDK to @percy/testcafe@1.0.0? Yes
```
This will automatically run the changes described below for you.
### Manually
#### Installing `@percy/cli`
If you're coming from a pre-2.0 version of this package, make sure to install `@percy/cli` after
upgrading to retain any existing scripts that reference the Percy CLI command.
```sh-session
$ npm install --save-dev @percy/cli
```
#### Migrating Config
If you have a previous Percy configuration file, migrate it to the newest version with the
[`config:migrate`](https://github.com/percy/cli/tree/master/packages/cli-config#percy-configmigrate-filepath-output) command:
```sh-session
$ percy config:migrate
```