davidguthu/mutant

Mutation testing for Ruby - Semantic code coverage

mutant

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 meaningful 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.
• Then select and setup your integration, also make sure you can reproduce the examples in the integration specific documentation.
• Identify your preferred mutation testing strategy. It is recommended to start at the commit level, to test only the code you had been touching. See the incremental mutation testing documentation.

Ruby Versions

Mutant currently only works on cRuby/MRI. Starting with version 2.5.x. It supports all syntax features upto and including Ruby 2.6.

Support for 2.7 syntax features is pending, see unparser issue: mbj/unparser#129.

Mutant will work under Ruby 2.7 just fine, unless a 2.7 syntax feature is used. This will be resolved shortly.

Licensing

Mutant was recently transitioned commercial software, with a free usage plan for opensource projects.

Commercial projects have to acquire a license per developer, with unlimited repositories per developer.

Opensource projects have to acquire their free license per repository.

The license distribution happens through the mutant-license gem in mutants dependencies. This gem is dynamically generated per licensee and comes with a unique license gem source URL.

After signup for a license the following has to be added to your Gemfile replacing ${key} with the license key and ${plan} with com for commercial or oss for opensource usage.

source 'https://${plan}:${key}@gem.mutant.dev' do
  gem 'mutant-license'
end

The mutant license gem contains metadata that allows mutant to verify licensed use.

For commercial licenses mutant checks the git commit author or the configured git email to be in the set of licensed developers.

For opensource licenses mutant checks the git remotes against the license whitelist. This allows the project maintainer to sign up and not bother collaborators with the details.

There are, apart from initial license gem installation, no remote interactions for license validation.

To inquire for license please contact Markus Schirp.

Pricing

Only relevant for commercial use.

Mutant offers a subscription model under a monthly plan. Yearly prepayments with discounts are available.

For higher volumes different arrangements can be negotiated.

Topics

• Nomenclature
• Reading Reports
• Known Problems
• Limitations
• Concurrency
• Rspec Integration
• Minitest Integration

Communication

Try the following:

• Github Issues
• Release Announcement Mailing List
• Slack channel request invite from Markus Schirp.

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.

Legal

Contents of this repository are maintained by:

Schirp DSO LTD
Director: Markus Schirp
Email: [email protected]
Vat-ID: MT24186727
Registration: C80467

Office address:
2, Carob Lane,
Sir Harry Luke Street
Naxxar NXR 2209,
Malta

Registred Address
Phoenix Business Centre,
The Penthouse,
Old Railway Track,
Santa Venera SVR9022,
Malta