Automated code reviews via mutation testing - semantic code coverage (fork of the latest free version)
Find a file
2014-10-08 14:27:07 +00:00
bin Fix exit status generation on intercepted interrrupts 2014-10-02 20:11:30 +00:00
config Remove unneded parser extension 2014-10-08 13:00:13 +00:00
lib Remove unneded parser extension 2014-10-08 13:00:13 +00:00
meta Prefer Object#is_a? over #kind_of? 2014-10-08 11:49:48 +00:00
spec Add mutation covering specs for Runner::Collector 2014-10-08 14:27:07 +00:00
test_app Skip method subjects defined in blocks 2014-09-16 21:07:26 +00:00
.gitignore Test both rspec 2 and 3 2014-03-03 20:00:57 +02:00
.rspec Use RSpec as receiver for rspec DSL methods 2014-08-10 21:04:07 +00:00
.rubocop.yml Update rubocop config 2014-05-27 14:46:00 +00:00
.ruby-gemset Add mutant gemset configuration 2013-07-28 11:33:49 -07:00
.travis.yml Remove exclude for 2.1.3 on travis 2014-10-08 13:00:42 +00:00
Changelog.md Change runner to use queue parallel interface 2014-10-08 00:03:18 +00:00
circle.yml Update to MRI 2.1.2 on circle 2014-05-23 01:11:27 +00:00
Gemfile Delete duplicate 'mutant' gem 2014-07-12 15:41:11 -07:00
Gemfile.devtools Update rubocop version for parser dependency bump of unparser 2014-09-25 18:05:56 +00:00
Guardfile Include guardfile from morpher, compatible with latest guard-rspec 2014-01-18 23:53:07 +01:00
LICENSE Update copyright year 2014-02-02 22:59:57 +01:00
mutant-rspec.gemspec Update to rspec-3.1.0 2014-09-17 18:11:01 +00:00
mutant.gemspec Remove unused inflecto dependency 2014-10-03 01:34:40 +00:00
Rakefile Adjust flay score 2014-06-02 15:15:04 +00:00
README.md Remove deprecated README section. 2014-09-04 16:23:14 +00:00
TODO Remove completed or obsolete TODO items 2014-06-15 19:02:02 +00:00

mutant

Build Status Dependency Status Code Climate Inline docs Gem Version

Mutant is a mutation testing tool for Ruby.

The idea is that if code can be changed and your tests do not notice, either that code isn't being covered or it does not have a speced side effect.

Mutant supports MRI and RBX 1.9, 2.0 and 2.1, while support for JRuby is planned. It should also work under any Ruby engine that supports POSIX-fork(2) semantics.

Mutant uses a pure Ruby parser and an unparser to do its magic.

Mutant does not have really good "getting started" documentation currently so please refer to presentations and blog posts below.

Mutation-Operators:

Mutant supports a wide range of mutation operators. An exhaustive list can be found in the mutant-meta. The mutant-meta is arranged to the AST-Node-Types of parser. Refer to parsers AST documentation in doubt.

There is no easy and universal way to count the number of mutation operators a tool supports.

Presentations

There are some presentations about mutant in the wild:

Blog-Posts

Projects using Mutant

The following projects adopted mutant, and aim for 100% mutation coverage:

Feel free to ping me to add your project to the list!

Installation

Install the gem mutant via your preferred method.

gem install mutant

If you plan to use the RSpec integration you'll have to install mutant-rspec also. Please add an explicit dependency to rspec-core for the RSpec version you want to use.

gem install mutant-rspec

The minitest integration is still in the works.

Examples

cd virtus
# Run mutant on virtus namespace
mutant --include lib --require virtus --use rspec Virtus*
# Run mutant on specific virtus class
mutant --include lib --require virtus --use rspec Virtus::Attribute
# Run mutant on specific virtus class method
mutant --include lib --require virtus --use rspec Virtus::Attribute.build
# Run mutant on specific virtus instance method
mutant --include lib --require virtus --use rspec Virtus::Attribute#type

Subjects

Mutant currently mutates code in instance and singleton methods. It is planned to support mutation of constant definitions and domain specific languages, DSL probably as plugins.

Test-Selection

Mutation testing is slow. The key to making it fast is selecting the correct set of tests to run. Mutant currently supports the following built-in strategy for selecting tests/specs:

Mutant uses the "longest rspec example group descriptions prefix match" to select the tests to run.

Example for a subject like Foo::Bar#baz it will run all example groups with description prefixes in Foo::Bar#baz, Foo::Bar and Foo. The order is important, so if mutant finds example groups in the current prefix level, these example groups must kill the mutation.

Rails

Assuming you are using rspec, you can mutation test Rails models by adding the following lines to your Gemfile:

group :test do
  gem 'mutant'
  gem 'mutant-rspec'
end  

Next, run bundle and comment out require 'rspec/autorun' from your spec_helper.rb file. Having done so you should be able to use commands like the following:

RAILS_ENV=test bundle exec mutant -r ./config/environment --use rspec User

Support

I'm very happy to receive/answer feedback/questions and criticism.

Your options:

There is also the [#mutant] channel on freenode. As my OSS time budged is very limited I cannot join it often. Please prefer to use GitHub issues with a 'Question: ' prefix in title.

Credits

Contributing

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with Rakefile or version (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

License

See LICENSE file.