Retry Flaky Tests

You can rerun certain tests with the WebdriverIO testrunner that turn out to be unstable due to e.g. flaky network or race conditions. However it is not recommended to just increase the rerun rate if tests become unstable.

Rerun suites in MochaJS

Since version 3 of MochaJS you can rerun whole test suites (everything inside an describe block). If you use Mocha you should favor this retry mechanism instead of the WebdriverIO implementation that only allows you to rerun certain test blocks (everything within an it block). Here is an example how to rerun a whole suite in MochaJS:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

describe('retries', function() {
    // Retry all tests in this suite up to 4 times
    this.retries(4);

    beforeEach(function () {
        browser.url('http://www.yahoo.com');
    });

    it('should succeed on the 3rd try', function () {
        // Specify this test to only retry up to 2 times
        this.retries(2);
        console.log('run');
        expect(browser.isVisible('.foo')).to.eventually.be.true;
    });
});

Rerun single tests in Jasmine or Mocha

To rerun a certain test block just apply the number of reruns as last parameter after the test block function:

1
2
3
4
5
6
7
8

describe('my flaky app', function () {
    /**
     * spec that runs max 4 times (1 actual run + 3 reruns)
     */
    it('should rerun a test at least 3 times', function () {
        // ...
    }, 3);
});

The same works for hooks too:

1
2
3
4
5
6
7
8
9
10

describe('my flaky app', function () {
    /**
     * hook that runs max 2 times (1 actual run + 1 rerun)
     */
    beforeEach(function () {
        // ...
    }, 1)

    // ...
});

It is not possible to rerun whole suites with Jasmine, only hooks or test blocks. To use this you have to have the wdio-mocha-framework adapter installed with v0.3.0 or greater or the wdio-jasmine-framework adapter with v0.2.0 or greater.

Rerun Step Definitions in Cucumber

To define a rerun rate for a certain step definitions just apply a retry option to it, like:

1
2
3
4
5
6
7
8

module.exports = function () {
    /**
     * step definition that runs max 3 times (1 actual run + 2 reruns)
     */
    this.Given(/^some step definition$/, { wrapperOptions: { retry: 2 } }, () => {
        // ...
    })
    // ...

Reruns can only be defined in your step definitions file and not in your feature file. To use this you have to have the wdio-cucumber-framework adapter installed with v0.1.0 or greater.