testcafe-reporter-saucelabs

This is the Sauce Labs reporter plugin for TestCafe.

If you are already using the Sauce Labs Browser Provider for running tests against Sauce Labs, then refrain from installing this reporter, as you will be creating duplicate reports.

Install

npm install testcafe-reporter-saucelabs

Requirement: Node.js 18 or higher.

Configuration

Sauce Labs credentials

SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables needs to be set to allow the plugin to report your results to Sauce Labs. Your Sauce Labs Username and Access Key are available from your dashboard.

Alternatively, you can use username and accessKey fields in the reporter configuration.

TestCafe Configuration

To configure the reporter, simply extend your TestCafe configuration file (e.g. .testcaferc.js):

module.exports = {
    sauce: {
        build:  "build123",
        tags:   [
            "app101",
        ],
        region: "us-west-1",
    }
}

Usage

When you run tests from the command line, specify the reporter name by using the --reporter option:

testcafe chrome 'path/to/test/file.js' --reporter saucelabs

When you use API, pass the reporter name to the reporter() method:

testCafe
    .createRunner()
    .src('path/to/test/file.js')
    .browsers('chrome')
    .reporter('saucelabs') // <-
    .run();

Development

Local Testing

In order to test the reporter, you'll need to link it to itself then run a test with the reporter set.

$ npm link
$ npm link testcafe-reporter-saucelabs
$ npx testcafe chrome tests/integration sauceswag.ok.test.js --reporter saucelabs

Common Issues

Problem

$ npx testcafe chrome tests/integration/sauceswag.test.js --reporter saucelabs
ERROR The "saucelabs" reporter does not exist. Check the reporter parameter for errors.

Solution

You need to re-link the package: npm link && npm link testcafe-reporter-saucelabs