protractor-errors

protractor-errors

A Jasmine wrapper for re-running failed Jasmine tests in Protractor.

install

npm install --save-dev protractor-errors or npm install -g protractor-errors to add cli

setup

required

Require the protractor-error module inside the Protractor config onPrepare function. This will execute the function that adds a JUnitXmlReporter to the Jasmine environment. If the params.errorsRun flag is set, the module will execute only errored specs from the most recent run inside the directory params.errorsPath. The error output is written to the directory params.errorsPath + params.currentTime.

var protractorErrors = require('protractor-errors');

// Below represents the protractor config file
exports.config = {
    // ...
    onPrepare: function() {
        protractorErrors.prepare();
    }
}

optional

Protractor errors now has the ability to filter out the successful suites. In order to use this please use the config function which will parse through the file globs in your original protractor config file, match the failed suites to the parent suite name and return back a list of just the failed files. This was ultimately created to reduce run time for error runs and to also reduce using unnecessary resources when pairing this with a cloud-based cross-browser testing tool.

var protractorErrors = require('protractor-errors');

// Pass the original protractor config into this config function
exports.config = protractorErrors.config({
    // ...
    onPrepare: function() {
        protractorErrors.prepare();
    }
})

If you want your errors run report to include the original run's results that did not change, call amend afterward.

var protractorErrors = require('protractor-errors');

// Below represents the protractor config file
exports.config = {
    // ...
    onComplete: function() {
        protractorErrors.amend();
    }
}

configuration

The module is configured by passing the following args or setting them inside the Protractor config:

params.errorsList: { suite: string; spec: string}[], params.errorsPath: string, directory where the JUnitXmlReporter will write output and the module will look for previous run data is no params.errorsList is defined. I recommend setting this in the Protractor configuration file since this should not change often.

params.currentTime: string, timestamp of the current test run. Triggering the test with the protractor-error cli runner will set this value automatically.

params.errorsRun?: boolean, default false, should the module limit the current run to previous errors

params.errorsTag?: string, mark the current run/reference previously tagged run for errors

Example:

protractor config.js --params.errorsPath 'jasmineReports' --params.currentTime '2017-01-24T23:53:06' --params.errorRun true

or

protractor-errors config.js --params.errorsPath 'jasmineReports' --params.errorRun true

cli

To automate setting the param.currentTime argument, trigger your protractor tests using the cli.

To run, either install protractor-errors globally and call: protractor-errors <config> [args] from the command line, with the same parameters you would call protractor. Or call the script by referencing the node_modules file directly: ./node_modules/protractor-errors/bin/protractor-errors.js <config> [args].