Mutation testing for Ruby
Clone or download
Latest commit 807d017 Dec 10, 2018

README.md

mutant

Build Status Code Climate Inline docs Gem Version Slack Status

What is Mutant?

Mutant is a mutation testing tool for Ruby. Mutation testing is a technique to verify semantic coverage of your code.

Why do I want it?

Mutant adds to your toolbox: Detection of uncovered semantics in your code. Coverage becomes a meaninful metric!

On each detection of uncovered semantics you have the opportunity to:

  • Delete dead code, as you do not want the extra semantics not specified by the tests
  • Add (or improve a test) to cover the unwanted semantics.
  • Learn something new about the semantics of Ruby and your direct and indirect dependencies.

How Do I use it?

  • Start with reading the nomenclature documentation.
  • Than select and setup your integration, also make sure you can reproduce the examples in the integration specific documentation.
  • Identify your preferred mutation testing strategy. Its recommended to start at the commit level, to test only the code you had been touching. See the incremental mutation testing documentation.

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

Topics

Sponsoring

Mutant, as published in the opensource version, would not exist without the help of contributors spending lots of their private time.

Additionally, the following features where sponsored by organizations:

  • The mutant-minitest integration was sponsored by Arkency
  • Mutant's initial concurrency support was sponsored by an undisclosed company that does currently not wish to be listed here.

If your organization is interested in sponsoring a feature, general maintainership or bugfixes, contact Markus Schirp.

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.

Neutral (noop) Tests

Mutant will also test the original, unmutated, version your code. This ensures that mutant is able to properly setup and run your tests. If an error occurs while mutant/rspec is running testing the original code, you will receive an error like the following:

--- Neutral failure ---
Original code was inserted unmutated. And the test did NOT PASS.
Your tests do not pass initially or you found a bug in mutant / unparser.
...
Test Output:
marshal data too short

Currently, troubleshooting these errors requires using a debugger and/or modyifying mutant to print out the error. You will want to rescue and inspect exceptions raised in this method: lib/mutant/integration/rspec.rb:call

Only Mutating Changed Code

Running mutant for the first time on an existing codebase can be a rather disheartening experience due to the large number of alive mutations found! Mutant has a setting that can help. Using the --since argument, mutant will only mutate code that has been modified. This allows you to introduce mutant into an existing code base without drowning in errors. Example usage that will mutate all code changed between master and the current branch:

bundle exec mutant --include lib --require virtus --since master --use rspec Virtus::Attribute#type

Presentations

There are some presentations about mutant in the wild:

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. Thanks 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 of 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 improve 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.

Blog posts

Sorted by recency:

Support

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

Your options:

There is also a mutation testing slack chat. Get an invite here. For discussing this project, join #mutant.

Other Channels:

  • #cosmic-ray: for discussing cosmic-ray, the python mutation testing tool.
  • #devtools: for discussing the devtools metagem.
  • #general: for general discussions about mutation testing.
  • #mutagen: for discussing mutagen, the javascript mutation testing tool.
  • #random: for misc. off topic discussion.
  • #stryker: for discussing stryker, the javascript mutation testing tool.
  • #wtf-dev: for sharing software development wtfs.

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.