free_mutant/README.md

mutant

Mutant is a mutation testing tool for ruby. It aims to be better than existing mutation testers.

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 gte 19-mode (1.9.3!), 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 for other test/spec frameworks than rspec2. Just create your own Mutant::Killer subclass, and make sure I get a PR!

See this ASCII-Cast for mutant in action! (v0.2.1)

Projects using Mutant

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

• axiom
• axiom-types
• rom-mapper
• rom-session
• event_bus
• virtus
• quacky
• substation
• various small/minor stuff under https://github.com/mbj

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

Installation

Install the gem mutant via your preferred method.

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 -I lib -r virtus --rspec-dm2 ::Virtus
# Run mutant on specific virtus class
mutant -I lib -r virtus --rspec-dm2 ::Virtus::Attribute
# Run mutant on specific virtus class method
mutant -I lib -r virtus --rspec-dm2 ::Virtus::Attribute.build
# Run mutant on specific virtus instance method
mutant -I lib -r virtus --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

• heckle

Support

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

Your options:

• GitHub Issues https://github.com/mbj/mutant/issues
• Ping me on https://twitter.com/m_b_j
• #rom-rb channel on freenode, I hang around on CET daytimes. (nick mbj)

Credits

• Markus Schirp (mbj)
• A gist from dkubb showing ideas.
• Older abandoned mutant. For motivating me doing this one.
• heckle. For getting me into mutation testing.

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.