RSpecFlaky

The most common reason for test flakiness is randomized factories which fill a database before test execution. This small gem is designed to help you find out what exactly attribute values were assigned to an investigated model during a failed and passed execution.

image

Installation

Add this line to test group of your application's Gemfile:

gem 'rspec-flaky'

Install the gem:

bundle

That's all. Select the model whose attributes will be dumped:

it 'is flaky test', tables: [User, Post] do
    expect([true, false]).to be true
end

Usage

Run the command to iteratively run flaky example (option -i specifies the number of iterations):

rspec-flaky path/to/flaky_spec.rb:12 -i 5

If at least one example is failed gem will generate tables where you are able to investigate source of flakiness by comparing failed and success attribute values. After running your tests, open tmp/flaky_tests/result.html in the browser of your choice. For example, in a Mac Terminal, run the following command from your application's root directory:

open tmp/flaky_tests/result.html

in a debian/ubuntu Terminal,

xdg-open tmp/flaky_tests/result.html

Note: This guide can help if you're unsure which command your particular operating system requires.

It's also possible to dump the whole database per each test example if there was a failed result as well as a passed result. For that just add -d option (currently only PostresQL is available):

rspec-flaky path/to/flaky_speЗc.rb:12 -i 10 -d

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request