DEPREDCATED

The TestCafe team no longer maintains the gulp-testcafe repository. If you want to take over the project, we'll be happy to hand it over. To contact the team, create a new GitHub issue.

gulp-testcafe

Run TestCafe tests using Gulp.

Install

npm install --save-dev gulp-testcafe

Usage

const gulp     = require('gulp');
const testcafe = require('gulp-testcafe');

gulp.task('default', () => {
    return gulp.src('test.js')
        .pipe(testcafe({ browsers: ['chrome', 'firefox'] }));
});

API

testcafe(options)

Options

browsers

Type: Array

Default: []

Details: Specifying Browsers for Test Task

Required

Configures the test runner to run tests in the specified browsers.

reporter

Type: String || Array

Default: spec

Details: Reporters

Specifies the reporter or an array of reporters.

Reporter can be specified by reporter name, or an object with following properties:

• name - name of the reporter,
• output - the file path where the report is written or the output stream.

Examples:

  "reporter": "minimal"

   "reporter": { "name": "json", "output": "report.json" }

    "reporter": { "name": "xunit", "output": fs.createWriteStream("report.xml") }

    "reporter": ["spec", { "name": "xunit", "output": fs.createWriteStream("report.xml") }]

filter

Type: function(testName, fixtureName, fixturePath)

Default: null

Details: runner.filter

Allows you to manually select which tests should be run.

screenshotsPath

Type: String

Default: null

Details: Screenshots path

The path to which the screenshots will be saved. Enables the test runner to take screenshots of the tested webpages.

takeScreenshotsOnFail

Type: Boolean

Default: false

Details: Take screenshots on fail

Specifies if screenshots should be taken automatically whenever a test fails. Requires that the screenshotsPath is set.

skipJsErrors

Type: Boolean

Default: false

Details: Skip JS errors

Defines whether to continue running a test after a JavaScript error occurs on a page (true), or consider such a test failed (false).

quarantineMode

Type: Boolean

Default: false

Defines whether to enable the quarantine mode.

selectorTimeout

Type: Number

Default: 10000

Details: Selector timeout

Specifies the amount of time, in milliseconds, within which selectors make attempts to obtain a node to be returned.

Author

Developer Express Inc. (https://devexpress.com)