Automated code reviews via mutation testing - semantic code coverage (fork of the latest free version)
Find a file
2013-08-04 23:05:46 +02:00
bin Move encoding line to the second line where rubycop will find it 2013-07-29 17:39:47 -07:00
config Adjust flay/flog scores 2013-08-04 23:03:39 +02:00
lib Add debug comment 2013-08-04 23:05:46 +02:00
spec Initial rspec killer with "longes description prefix match" 2013-08-04 18:49:42 +02:00
test_app Add magic encoding header to all ruby files 2013-07-28 16:03:06 -07:00
.gitignore Add gitignore from ROM style gems 2013-07-28 15:19:11 -07:00
.rspec Add rspec profiling and turn on warnings in specs 2013-07-29 17:34:11 -07:00
.ruby-gemset Add mutant gemset configuration 2013-07-28 11:33:49 -07:00
.travis.yml Move rvm section into matrix/include 2013-07-31 11:35:25 -07:00
Changelog.md Port case mutations to parser 2013-06-14 21:12:09 +02:00
circle.yml Name circle.yml correctly 2013-07-11 17:16:55 +02:00
Gemfile Initial rspec killer with "longes description prefix match" 2013-08-04 18:49:42 +02:00
Gemfile.devtools Upgrade gem dependencies 2013-08-01 22:51:11 -07:00
Guardfile Update Guardfile to match other ROM related gems 2013-07-28 12:15:55 -07:00
LICENSE Add LICENSE file 2012-12-28 18:38:39 +01:00
mutant.gemspec Add Mutant::Version and --version flag for CLI 2013-08-03 01:44:58 +02:00
Rakefile Add encoding to ruby files 2013-07-29 17:17:04 -07:00
README.md Merge branch 'master' into flexible-rspec 2013-08-02 00:28:15 +02:00
TODO Handle masgn outside of generic mutator 2013-07-05 13:48:13 +02:00

mutant

Build Status Dependency Status Code Climate

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.

A more readable introduction can be found under: http://solnic.eu/2013/01/23/mutation-testing-with-mutant.html

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

Only rspec2 is supported currently. This is subject to change.

It is easy to write a mutation killer/strategy for other test/spec frameworks than rspec2.

Projects using Mutant

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

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

Installation

Install the gem mutant via your preferred method.

The 0.2 series is stable but has outdated dependencies. The 0.3 series is in beta phase currently.

gem install mutant --pre

Mutations

Mutant supports a very wide range of mutation operators. Listing them all in detail would blow this document up.

It is planned to parse a list of mutation operators from the source. In the meantime please refer to the code each subclass of Mutant::Mutator::Node emits around 3-6 mutations.

Currently mutant covers the majority of ruby's complex nodes that often occur in method bodies.

A some stats from the axiom library:

Subjects:  417       # Amount of subjects being mutated (currently only methods)
Mutations: 5442      # Amount of mutations mutant generated (~13 mutations per method)
Kills:     5385      # Amount of successfully killed mutations
Runtime:   1898.11s  # Total runtime
Killtime:  1884.17s  # Time spend killing mutations
Overhead:  0.73%
Coverage:  98.95%    # Coverage score
Alive:     57        # Amount of alive mutations.

Nodes still missing a dedicated mutator are handled via the Generic mutator. The goal is to remove this mutator and have dedicated mutator for every type of node and removing the Generic handler altogether.

Examples

CLI will be simplified in the next releases, but currently stick with this:

cd virtus
# Run mutant on virtus namespace (that uses the dm-2 style spec layout)
mutant --rspec-dm2 '::Virtus*'
# Run mutant on specific virtus class
mutant --rspec-dm2 ::Virtus::Attribute
# Run mutant on specific virtus class method
mutant --rspec-dm2 ::Virtus::Attribute.build
# Run mutant on specific virtus instance method
mutant --rspec-dm2 ::Virtus::Attribute#name

Strategies

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 strategies for selecting tests/specs.

--rspec-dm2

This strategy is the fastest but requires discipline in spec file naming.

The following specs are executed to kill a mutation on:

Public instance  methods: spec/unit/#{namespace}/#{class_name}/#{method_name}_spec.rb
Public singleton methods: spec/unit/#{namespace}/#{class_name}/class_methods/#{method_name}_spec.rb
Private instance  methods: spec/unit/#{namespace}/#{class_name}/*_spec.rb
Private singleton methods: spec/unit/#{namespace}/#{class_name}/class_methods/*_spec.rb

Expansions:

Symbolic operator-like methods are expanded, e.g. Foo#<< is expanded to:

spec/unit/foo/left_shift_operator_spec.rb

The full list of expansions can be found here:

https://github.com/mbj/mutant/blob/master/lib/mutant/constants.rb

--rspec-unit

This strategy executes all specs under ./spec/unit for each mutation.

--rspec-integration

This strategy executes all specs under ./spec/integration for each mutation.

--rspec-full

This strategy executes all specs under ./spec for each mutation.

In the future, we plan on allowing explicit selections on the specs to be run, as well as support for other test frameworks. Custom project specific strategies are also on the roadmap.

Alternatives

Support

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

Your options:

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.