jardakotesovec/protractor-retry

Protractor-retry

A solution to address the flakyness of your Protractor FE automation test suites.
This module used protractor features to automatically re-run failed tests with a specific configurable number of attempts.
This module is added in our CICD pipelines where we have a zero failure policy in order to bless an environment.
Mocha & Jasmine are supported.

This module fully relies on protractor available callbacks and internal functionalities.

It is from within protractor itself and not relying on any external dependency. All the changes that you need to add in order to integrate this module is located only in one file, the protractor configuration file. *You don’t need to update a single line of the spec.js files.

The module will create an XML file which contains the failed spec(s) filename(s). and will re-run only them, till either we don't have anymore failures or we reached the retry attempt maximum.

The process of retrying is not happening on the fly of a test failure but only after the whole testsuite is run. The failed tests are stored and only those ones are going to be rerun.

Steps to Integrate

Install

npm i -g  protractor-retry

Step 1: Require the Package ( Your Protractor Config )

var retry = require('protractor-retry').retry;

Step 2: onPrepare ( Your Protractor Config )

onPrepare: function() {
  retry.onPrepare();
}

Step 3: onCleanUp ( Your Protractor Config )

onCleanUp = function(results) {
    retry.onCleanUp(results);
};

It is Mandatory to provide the results to the retry.onCleanUp function

Step 4: afterLaunch ( Your Protractor Config )

afterLaunch = function() {
   return retry.afterLaunch(NUMBER_OF_RETRIES);
}

It is Mandatory to use return here

Full Protractor Config snippet with 2 retries

exports.config = {
    // rest of your config
    onCleanUp: function (results) {
        retry.onCleanUp(results);
    },
    onPrepare: function () {
        retry.onPrepare();
    },
    afterLaunch: function() {
        return retry.afterLaunch(2);
    }
};

Examples

Checkout this Mocha Example protractor.mocha.conf.js
Checkout this Jasmine Example protractor.jasmine.conf.js
Checkout this TestSuite Example with DEBUG activated protractor.suite.conf.js

Known Caveat

If you are NOT Running in Parallel mode, the package will retry the whole testsuite if any failure.

jardakotesovec / protractor-retry