-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Enhance mutation testing documentation with new sections #50594
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
cosminvladutu
wants to merge
4
commits into
dotnet:main
Choose a base branch
from
cosminvladutu:patch-2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+55
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
79e8626
Enhance mutation testing documentation with new sections
cosminvladutu f2dd3f3
Update docs/core/testing/mutation-testing.md
cosminvladutu 929f19b
Update docs/core/testing/mutation-testing.md
cosminvladutu e9c6588
Update docs/core/testing/mutation-testing.md
cosminvladutu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -110,6 +110,61 @@ | |
|
|
||
| For additional mutation types, see the [Stryker.NET: Mutations](https://stryker-mutator.io/docs/stryker-net/mutations) documentation. | ||
|
|
||
| ## Interpret mutation testing results | ||
|
|
||
| After running Stryker.NET, you'll receive a report that categorizes mutants as **killed**, **survived**, or **timeout**. Here's how to interpret and act on these results: | ||
|
|
||
| - **Killed**: These are changes that your tests successfully caught. A high number of killed mutants indicates that your test suite effectively detects logic errors. | ||
|
|
||
| - **Survived**: These changes weren't caught by your tests. Review them to identify gaps in test coverage or assertions that are too weak. Focus on adding targeted unit tests that would fail if the mutant were real. | ||
|
|
||
| - **Timeout**: These mutations caused your code to hang or exceed the allowed time. This can happen with infinite loops or unoptimized paths. Investigate the code logic or increase the timeout threshold if needed. | ||
|
|
||
| > [!NOTE] | ||
| > Don't chase a 100% mutation score. Instead, focus on high-risk or business-critical areas where undetected bugs would be most costly. | ||
|
|
||
| ## Adding mutation testing to your CI/CD workflow | ||
|
|
||
| You can seamlessly integrate mutation testing into your continuous integration and delivery workflows. For instance, Stryker.NET can be configured to run within your Azure Pipelines or GitHub Actions setup, allowing you to enforce quality thresholds as part of your automated testing process. | ||
|
|
||
| Add the following to your `stryker-config.json` file to set mutation score thresholds: | ||
|
|
||
| ```json | ||
| { | ||
| "thresholds": { | ||
| "high": 85, | ||
| "low": 65, | ||
| "break": 0 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Customization | ||
|
|
||
| Besides setting thresholds for your pipeline, Stryker.NET offers the possibility of having different configurations for each of your project needs. You can do this customization of behavior using the _stryker-config.json_ file. | ||
| ```json | ||
|
Check failure on line 145 in docs/core/testing/mutation-testing.md
|
||
| { | ||
| "ignore-mutations": [ | ||
| "ToString", | ||
| "Equals", | ||
| "GetHashCode" | ||
| ], | ||
| "ignore-methods": [ | ||
| "*Logs" | ||
| ] | ||
| "mutate": [ | ||
| "!**/Migrations/*", | ||
| "!**/*.Designer.cs" | ||
| ] | ||
| } | ||
cosminvladutu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| - **ignore-mutations**: These are the methods or expressions that you want to ignore because they are noisy, or you consider not needed based on your application logic needs. They will show up in your reports as `Ignored`. | ||
| - **ignore-methods**: You can use this to skip entire methods based on their signatures. Also, those will appear in your reports as Ignored. In our example, we ignore all methods ending in "Logs". | ||
| - **mutate**: Without this option, Stryker will try to mutate all the files in your project. With this, you can ignore files or entire folders. In the example above, we ignore everything inside a _Migrations_ folder and all _.Designer.cs_ files (which are usually autogenerated) . | ||
|
|
||
| For more information, see [Stryker: Configuration](https://stryker-mutator.io/docs/stryker-net/configuration/). | ||
|
|
||
| ## Incremental improvement | ||
|
|
||
| If, after changing your code, the unit tests pass successfully, then they aren't sufficiently robust, and the mutant survived. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.