Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
4 contributors

Users who have contributed to this file

@Mobrockers @richardwerkman @MadsPB @dupdob
243 lines (187 sloc) 7.77 KB

For .NET Core projects Stryker.NET can be run without any configuration. On .NET Framework projects the solution path is required.

The full list of Stryker.NET configuration options are:

Solution path

On .NET Framework projects Stryker needs your .sln file path.

dotnet stryker --solution-path "..\\ExampleProject.sln"
dotnet stryker -s "..\\ExampleProject.sln"

Stryker.NET needs the path to execute:

nuget restore "*.sln"

and

MSBuild.exe "*.sln"

Project file

When Stryker finds two or more project references inside your test project, it needs to know which project should be mutated. Pass the name of this project using:

dotnet stryker --project-file SomeProjectName.csproj
dotnet stryker -p SomeProjectName.csproj

Test Project file

When Stryker finds two or more project files in the working directory, it needs to which is your test project. Pass the name of this project using:

dotnet stryker --test-project-file ExampleTestProject.csproj
dotnet stryker -tp ExampleTestProject.csproj

Specify testrunner

Stryker supports dotnet test, the commandline testrunner and VsTest, the visual studio testrunner. VsTest is the default because it offers tight integration with all test frameworks (MsTest, xUnit, NUnit etc). Dotnet test can be used if VsTest causes issues for some reason. Please also submit an issue with us if you experience difficulties with VsTest.

dotnet stryker --test-runner dotnettest
dotnet stryker -tr dotnettest

Default: "vstest"

Timeout time

Some mutations can create endless loops inside your code. To detect and stop these loops, Stryker cancels a unit test run after a set time. Using this parameter you can increase or decrease the time before a test will time out.

dotnet stryker --timeout-ms 1000
dotnet stryker -t 1000

Default: "5000"

Reporters

During a mutation testrun one or more reporters can be enabled. A reporter will produce some kind of output during or after the mutation testrun.

dotnet stryker --reporters "['html', 'progress']"
dotnet stryker -r "['html', 'progress']"

You can find a list of all available reporters and what output they produce in the reporter docs

Default: "['cleartext', 'progress']"

Logging to console

To gain more insight in what Stryker does during a mutation testrun you can lower your loglevel.

dotnet stryker --log-level "debug"
dotnet stryker -l "debug"

All available loglevels are:

  • error
  • warning
  • info
  • debug
  • trace

Default: "info"

Logging to a file

When creating an issue for Stryker.NET on github you can include a logfile. File logging always uses loglevel trace.

dotnet stryker --log-file
dotnet stryker -f

Default: off

Maximum concurrent test runners

By default Stryker.NET will use as much CPU power as you allow it to use during a mutation testrun. You can lower this setting to lower your CPU usage.

dotnet stryker --max-concurrent-test-runners 4
dotnet stryker -c 4

This setting can also be used to disable parallel testing. This can be useful if your test project cannot handle parallel testruns.

dotnet stryker -c 1

Default: your number of logical processors / 2*

* This usually equals your physical processor count

Custom thresholds

If you want to decide on your own mutation score thresholds, you can configure this with extra parameters.

dotnet stryker --threshold-high 90 --threshold-low 75 --threshold-break 50
dotnet stryker -th 90 -tl 75 -tb 50
  • mutation score > threshold-high:
    • Awesome! Your reporters will color this green and happy.
  • threshold-high > mutation score > threshold-low:
    • Warning! Your reporters will display yellow/orange colors, watch out!
  • threshold-low < mutation score > threshold-break:
    • Danger! Your reporters will display red colors, you're in the danger zone now.
  • threshold-break > mutation score:
    • Error! The application will exit with exit code 1.

Default: 80, 60, 0

Excluding mutations

If you deem some mutations unwanted for your project you can disable mutations.

dotnet stryker --excluded-mutations "['string', 'logical']"
dotnet stryker -em "['string', 'logical']"

The mutations of these kinds will be skipped and not be shown in your reports. This can also speed up your performance on large projects. But don't get too exited, skipping mutations doesn't improve your mutation score ;)

Excluding files

If you decide to exclude files for unit testing, you can configure this with the following command:

dotnet stryker --files-to-exclude "['./ExampleClass.cs', './ExampleDirectory', './ExampleDirectory/ExampleClass2.cs']"
dotnet stryker -fte "['./ExampleClass.cs', './ExampleDirectory', './ExampleDirectory/ExampleClass2.cs']"

We recommend to use relative paths. Relative paths are automatically resolved. Absolute paths break easily on different devices. However it is also possible to use absolute paths.

When you want to exclude a large set of files, it is advised to use the stryker configuration file because it is easier to handle multiple files.

Default: []

Use a config file

There is also the option to use a config file. To use a config file all you have to do is add a file called stryker-config.json in the root of your test project and add a configuration section called stryker-config. Then you can add the options you want to configure to the file.

Example config file:

{
    "stryker-config":
    {
        "test-runner": "vstest",
        "reporters": [
            "progress",
            "html"
        ],
        "log-level": "info",
        "log-file":true,
        "timeout-ms": 10000,
        "project-file": "ExampleProject.csproj",
        "max-concurrent-test-runners": 4,
        "threshold-high": 80,
        "threshold-low": 70,
        "threshold-break": 60,
        "files-to-exclude": [
            "./ExampleClass.cs",
            "./ExampleDirectory/",
            "./ExampleDirectory/ExampleClass2.cs",
            "C:\\ExampleRepo\\ExampleDirectory\\ExampleClass.cs"
        ],
        "excluded-mutations": [
            "string",
            "Logical operators"
        ]
    }
}

Config file location

If you want to integrate these settings in your existing settings json, make sure the section is called stryker-config and run stryker with the command

dotnet stryker --config-file-path <relativePathToFile>
dotnet stryker -cp <relativePathToFile>

Default: "./stryker-config.json"

Coverage analysis

Use coverage info to speed up execution. Possible values are: off, perTest, all, perIsolatedTest.

  • off: coverage data is not captured (default mode).
  • perTest: capture the list of mutants covered by each test. For every mutant that has tests, only the tests that cover a the mutant are tested. Fastest option.
  • all: capture the list of mutants covered by each test. Test only these mutants. Non covered mutants are assumed as survivors. Fast option.
  • perTestInIsolation: like 'perTest', but running each test in an isolated run. Slowest fast option.
dotnet stryker --coverage-analysis perTest
dotnet stryker -ca perTest

Default: "off"

Abort test on fail

Abort unit testrun as soon as any one unit test fails. This can reduce the overall running time.

dotnet stryker --abort-test-on-fail
dotnet stryker -atof

Default: "off"

You can’t perform that action at this time.