protractor-retry

To help you get started, we've collected the most common ways that protractor-retry is being used within popular public projects.

Activiti / activiti-modeling-app / e2e / config / hooks / after-launch.js View on Github

const argv = require('yargs').argv;
const uploadOutput = require('../utils/upload-output');
const retry = require('protractor-retry').retry;

const FOLDER = process.env.FOLDER || '',
    SAVE_SCREENSHOT = process.env.SAVE_SCREENSHOT === 'true';

async function afterLaunch(statusCode) {

    if (SAVE_SCREENSHOT && statusCode === 1) {
        console.log(`Status code is ${statusCode}, trying to save screenshots.`);
        let retryCount = 1;
        if (argv.retry) {
            retryCount = ++argv.retry;
        }

        try {
            console.log('Retry number: ', retryCount);
            await uploadOutput(FOLDER, retryCount);

View more ways to use 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.
• NEW : WINDOWS Support UPDATE : Windows as an env to launch with version 2.0.1

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

It is build 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, ie to summarize :

• You don’t need to update a single line of your tests spec.js files.
• Only few lines to add in your protractor conf file needed.

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 afterwards by creating on the fly a new "failed only" files testsuite.

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 (Firefox capability) Example protractor.mocha.conf.js
• Checkout this Jasmine (Chrome cap.) Example protractor.jasmine.conf.js
• Checkout this TestSuite (IE11 cap.) Example with DEBUG mode activated protractor.suite.conf.js

Those 3 examples are actually used for the functional tests coverage of this package. Please take a look at the Travis output to check out the flow of the retries.

Known Caveat

• If you are NOT Running in Parallel mode, the package will retry the whole testsuite if any failure.
• Windows as an environment to launch & use this package is unfortunately not yet supported.
• WINDOWS SUPPORT UPDATE Supported from version 2.0.1