Crystalball is a Ruby library which implements Regression Test Selection mechanism originally published by Aaron Patterson. Its main purpose is to select a subset of your test suite which should be run to ensure your changes didn't break anything.
Add this line to your application's Gemfile:
group :test do
gem 'crystalball'
end
And then execute:
$ bundle
Or install it yourself as:
$ gem install crystalball
- Add
Crystalball::MapGenerator.start!
to yourspec_helper
before you loaded any file of your app. - Run your test suite on clean branch with green build. This step will create file
execution_map.yml
in your project root - Make some changes to your app code
- Call
Crystalball.foresee
to see list of tests which might fail because of your changes.
TODO: Write good description for anyone who wants to customize behavior
- 100% spec coverage
- Different strategies for source diff
- Different strategies for failure predictor
- Different strategies for execution map
- Guard replacement
- integration for git hook
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/pluff/crystalball. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.