RSpec::Retry

RSpec::Retry adds a :retry option for intermittently failing rspec examples. If an example has the :retry option, rspec will retry the example the specified number of times until the example succeeds.

Compatibility

Rspec Version	Rspec-Retry Version
> 3.8	0.6.2 but untested
> 3.3, <= 3.8	0.6.2
3.2	0.4.6
2.14.8	0.4.4

Maintenance Expectations

NoRedInk used to be a Ruby shop, and we open-sourced this in the hope that it will help other people. However, we've been moving away from Ruby for some time now, and only plan to do maintenance on this repo when we have an internal need for it. We don't plan to add any new functionality, and expect that it will fall behind the latest versions of Ruby and Rspec.

That said, if you're reading this and you need this gem to do something new, feel free to fork it and publish your own gem! If you open an issue here to let us know about your fork, we can add a link to it from this repo to help folks find something that's more actively maintained.

Installation

Add this line to your application's Gemfile:

gem 'rspec-retry', group: :test # Unlike rspec, this doesn't need to be included in development group

And then execute:

$ bundle

Or install it yourself as:

$ gem install rspec-retry

require in spec_helper.rb

# spec/spec_helper.rb
require 'rspec/retry'

RSpec.configure do |config|
  # show retry status in spec process
  config.verbose_retry = true
  # show exception that triggers a retry if verbose_retry is set to true
  config.display_try_failure_messages = true

  # run retry only on features
  config.around :each, :js do |ex|
    ex.run_with_retry retry: 3
  end

  # callback to be run between retries
  config.retry_callback = proc do |ex|
    # run some additional clean up task - can be filtered by example metadata
    if ex.metadata[:js]
      Capybara.reset!
    end
  end
end

Usage

it 'should randomly succeed', :retry => 3 do
  expect(rand(2)).to eq(1)
end

it 'should succeed after a while', :retry => 3, :retry_wait => 10 do
  expect(command('service myservice status')).to eq('started')
end
# run spec (following log is shown if verbose_retry options is true)
# RSpec::Retry: 2nd try ./spec/lib/random_spec.rb:49
# RSpec::Retry: 3rd try ./spec/lib/random_spec.rb:49

Calling `run_with_retry` programmatically

You can call ex.run_with_retry(opts) on an individual example.

Configuration

:verbose_retry(default: false) Print retry status
:display_try_failure_messages (default: false) If verbose retry is enabled, print what reason forced the retry
:default_retry_count(default: 1) If retry count is not set in an example, this value is used by default. Note that currently this is a 'try' count. If increased from the default of 1, all examples will be retried. We plan to fix this as a breaking change in version 1.0.
:default_sleep_interval(default: 0) Seconds to wait between retries
:clear_lets_on_failure(default: true) Clear memoized values for lets before retrying
:exceptions_to_hard_fail(default: []) List of exceptions that will trigger an immediate test failure without retry. Takes precedence over :exceptions_to_retry
:exceptions_to_retry(default: []) List of exceptions that will trigger a retry (when empty, all exceptions will)
:retry_callback(default: nil) Callback function to be called between retries

Environment Variables

RSPEC_RETRY_RETRY_COUNT can override the retry counts even if a retry count is set in an example or default_retry_count is set in a configuration.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create a pull request

federicoaldunate/rspec-retry