rspec-retry only features (capybara) tests on CI

README.md

rspec-retry gem

Retry tests 3 times on CI only (when CI environment variable is present). In development run tests only once for easier development.

related

How to retry failed tests (flaky tests)? https://knapsackpro.com/faq/question/how-to-retry-failed-tests-flaky-tests

Fix intermittently failing CI builds due to flaky tests in RSpec https://docs.knapsackpro.com/2021/fix-intermittently-failing-ci-builds-flaky-tests-rspec

rspec_retry.rb

# spec/support/config/rspec_retry.rb
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|
    # retry test 3 times on CI but do not retry when testing locally
    ex.run_with_retry retry: (ENV['CI'] ? 3 : 1)
  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