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 ruby >= 2.1, while support for JRuby is planned. It should also work under any Ruby engine that supports POSIX-fork(2) semantics.
Mutant does not have really good "getting started" documentation currently so please refer to presentations and blog posts below.
Mutant supports a wide range of mutation operators. An exhaustive list can be found in the mutant-meta.
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.
There are some presentations about mutant in the wild:
- RailsConf 2014 / http://confreaks.com/videos/3333-railsconf-mutation-testing-with-mutant
- Wrocloverb 2014 / https://www.youtube.com/watch?v=rz-lFKEioLk
- eurucamp 2013 / FrOSCon-2013 http://slid.es/markusschirp/mutation-testing
- Cologne.rb / https://github.com/DonSchado/colognerb-on-mutant/blob/master/mutation_testing_slides.pdf
As mutant right now only supports rspec, install the gem
mutant-rspec via your preferred method.
It'll pull the
mutant gem (in correct version), that contains the main engine.
gem install mutant-rspec
The minitest integration is still in the works.
The Crash / Stuck Problem (MRI)
Mutations generated by mutant can cause MRI to enter VM states its not prepared for. All MRI versions > 1.9 and < 2.2.1 are affected by this depending on your compiler flags, compiler version, and OS scheduling behavior.
This can have the following unintended effects:
MRI crashes with a segfault. Mutant kills each mutation in a dedicated fork to isolate the mutations side effects when this fork terminates abnormally (segfault) mutant counts the mutation as killed.
MRI crashes with a segfault and gets stuck when handling the segfault. Depending on the number of active kill jobs mutant might appear to continue normally until all workers are stuck into this state when it begins to hang. Currently mutant must assume that your test suite simply not terminated yet as from the outside (parent process) the difference between a long running test and a stuck MRI is not observable. Its planned to implement a timeout enforced from the parent process, but ideally MRI simply gets fixed.
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
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.
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. The order is important, so if mutant finds example groups in the
current prefix level, these example groups must kill the mutation.
Mutation output is grouped by selection groups. Each group contains three sections:
An identifier for the current group.
[SUBJECT EXPRESSION]:[SOURCE LOCATION]:[LINENO]
A list of specs that mutant ran to try to kill mutations for the current group.
- [INTEGRATION]:0:[SPEC LOCATION]:[SPEC DESCRIPTION] - [INTEGRATION]:1:[SPEC LOCATION]:[SPEC DESCRIPTION]
- rspec:0:./spec/unit/book_spec.rb:9/Book#add_page should return self - rspec:1:./spec/unit/book_spec.rb:13/Book#add_page should add page to book
A list of unkilled mutations diffed against the original unparsed source
[MUTATION TYPE]:[SUBJECT EXPRESSION]:[SOURCE LOCATION]:[SOURCE LINENO]:[IDENTIFIER] [DIFF] -----------------------
[MUTATION TYPE]will be one of the following:
evil- a mutation of your source was not killed by your tests
neutralyour original source was injected and one or more tests failed
[IDENTIFIER]- Unique identifier for this mutation
evil:Book#add_page:Book#add_page:/home/dev/mutant-examples/lib/book.rb:18:01f69 @@ -1,6 +1,6 @@ def add_page(page) - @pages << page + @pages @index[page.number] = page self end ----------------------- evil:Book#add_page:Book#add_page:/home/dev/mutant-examples/lib/book.rb:18:b1ff2 @@ -1,6 +1,6 @@ def add_page(page) - @pages << page + self @index[page.number] = page self end -----------------------
Planning a presentation?
Mutation testing lately (not only mutant) seems to attract some attention. So naturally people do talks about it at conferences, user groups or other chances. Thx for that!
As I (the author @mbj) am not too happy with some of the facts being presented about mutant the last month.
So if you plan to do a presentation: I offer to review your slides / talk - for free off course. My intention is NOT to change your bias pro / against this tool. Just to help to fix invalid statements about the tool.
Also in many cases a conversation to the author, should help you to imporve the talk significantly. One of mutants biggest weaknesses is the bad documentation, but instead of assumptions based on the absence of docs, use the tool authors brain to fill the gaps.
Hint, same applies to papers.
Assuming you are using rspec, you can mutation test Rails models by adding the following lines to your Gemfile:
group :test do 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
I'm very happy to receive/answer feedback/questions and criticism.
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.
- Markus Schirp (mbj)
- A gist, now removed, from dkubb showing ideas.
- Older abandoned mutant. For motivating me doing this one.
- heckle. For getting me into mutation testing.
- 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.
See LICENSE file.