Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.85 KB

README.md

File metadata and controls

81 lines (59 loc) · 3.85 KB
Raw

Nuget Nuget Azure DevOps build Azure DevOps tests Slack

Stryker.NET

Professor X: For someone who hates mutants... you certainly keep some strange company. William Stryker: Oh, they serve their purpose... as long as they can be controlled.

Introduction

Stryker.NET offers you mutation testing for your .NET Core and .NET Framework projects. It allows you to test your tests by temporarily inserting bugs.

For an introduction to mutation testing and Stryker's features, see stryker-mutator.io. Looking for mutation testing in JavaScript & Typescript or Scala?

Getting started

Stryker.NET is installed using NuGet as a dotnet core global tool. Stryker.NET can be installed in one of these ways:

Global install

dotnet tool install -g dotnet-stryker

Project install

Starting from dotnet core 3.0 dotnet tools can also be installed on a project level. This requires the following steps:

Create a file called dotnet-tools.json in your project folder. You can checkin to version control to make sure all team members have access to stryker

dotnet new tool-manifest

Then install stryker without the -g flag while executing the following command in the project folder

dotnet tool install dotnet-stryker

Now you can run Stryker.NET from your test project directory by executing:

dotnet stryker

Documentation

For the full documentation on how to use Stryker.NET, see our configuration docs.

Update stryker dotnet tool

Dotnet global tools do not auto update. To update stryker as a global tool run dotnet tool update --global dotnet-stryker. Stryker will notify you when a new version is available on every run.

Compatibility

Runs on test projects targeting:

  • netcoreapp 1.1+
  • netframework 4.5+

Requirements

Dotnet core runtime 3.1+ needs to be available on your system to run dotnet stryker.

For .NET Framework projects, Stryker.NET requires nuget.exe to be installed on your system. Please follow their installation instructions.

Supported Mutators

Right now, Stryker.NET supports the following mutations:

  • Arithmetic Operators
  • Equality Operators
  • Boolean Literals
  • Assignment statements
  • Collection initialization
  • Unary Operators
  • Update Operators
  • Checked Statements
  • Linq Methods
  • String Literals
  • Bitwise Operators

For the full list of all available mutations, see the mutator docs.

Supported Reporters

  • Html reporter
  • Dashboard reporter
  • Console reporter
  • Progress reporter
  • Console dots reporter
  • Json reporter

For the full list of all available reporters, see the reporter docs.

Contributing

Want to help develop Stryker.NET? Check out our contribution guide.