Skip to content

Fix Stryker tool XML summaries #520

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.

Sign up for GitHub

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

Merged
ITaluone merged 1 commit into from
Jul 23, 2026
Merged

Fix Stryker tool XML summaries #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/Fallout.Common/Tools/Stryker/Stryker.Generated.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public partial class StrykerSettings : ToolOptions
[Argument(Format = "--reporter {value}")] public IReadOnlyList<StrykerReporter> Reporters => Get<List<StrykerReporter>>(() => Reporters);
/// <summary>When this option is passed, generated reports should open in the browser automatically once Stryker starts testing mutants, and will update the report till Stryker is done. Both html and dashboard reports can be opened automatically.</summary>
[Argument(Format = "--open-report:{value}")] public StrykerOpenReport OpenReport => Get<StrykerOpenReport>(() => OpenReport);
/// <summary>Change the amount of concurrent workers Stryker uses for the mutation testrun. Defaults to using half your logical (virtual) processor count.<p><strong>Example<strong>: an intel i7 quad-core with hyperthreading has 8 logical cores and 4 physical cores. Stryker will use 4 concurrent workers when using the default.</p></summary>
/// <summary>Change the amount of concurrent workers Stryker uses for the mutation testrun. Defaults to using half your logical (virtual) processor count.<p><strong>Example</strong>: an intel i7 quad-core with hyperthreading has 8 logical cores and 4 physical cores. Stryker will use 4 concurrent workers when using the default.</p></summary>
[Argument(Format = "--concurrency {value}")] public uint? Concurrency => Get<uint?>(() => Concurrency);
/// <summary>Must be less than or equal to threshold low. When threshold break is set to anything other than 0 and the mutation score is lower than the threshold Stryker will exit with a non-zero code. This can be used in a CI pipeline to fail the pipeline when your mutation score is not sufficient.</summary>
[Argument(Format = "--break-at {value}")] public uint? BreakAt => Get<uint?>(() => BreakAt);
Expand All @@ -76,7 +76,7 @@ public partial class StrykerSettings : ToolOptions
[Argument(Format = "--disable-bail")] public bool? DisableBail => Get<bool?>(() => DisableBail);
/// <summary>Enabling with-baseline saves the mutation report to a storage location such as the filesystem. The mutation report is loaded at the start of the next mutation run. Any changed source code or unit test results in a reset of the mutants affected by the change. For unchanged mutants the previous result is reused. This feature expands on the since feature by providing you with a full report after a partial mutation testrun.</summary>
[Argument(Format = "--with-baseline:{value}")] public string WithBaseline => Get<string>(() => WithBaseline);
/// <summary><p>Use git information to test only code changes since the given target. Stryker will only report on mutants within the changed code. All other mutants will not have a result.</p><p>If you wish to test only changed sources and tests but would like to have a complete mutation report see with-baseline.</p><p>Set the diffing target on the command line by passing a committish with the since flag in the format <c>--since:<committish></c>. Set the diffing target in the config file by setting the since target option.</p><p><i>* For changes on test project files all mutants covered by tests in that file will be seen as changed.</i></p></summary>
/// <summary><p>Use git information to test only code changes since the given target. Stryker will only report on mutants within the changed code. All other mutants will not have a result.</p><p>If you wish to test only changed sources and tests but would like to have a complete mutation report see with-baseline.</p><p>Set the diffing target on the command line by passing a committish with the since flag in the format <c>--since:&lt;committish&gt;</c>. Set the diffing target in the config file by setting the since target option.</p><p><i>* For changes on test project files all mutants covered by tests in that file will be seen as changed.</i></p></summary>
[Argument(Format = "--since:{value}")] public string Since => Get<string>(() => Since);
/// <summary>Change the console <c>verbosity</c> of Stryker when you want more or less details about the mutation testrun.</summary>
[Argument(Format = "--verbosity {value}")] public StrykerVerbosity Verbosity => Get<StrykerVerbosity>(() => Verbosity);
Expand All @@ -92,15 +92,15 @@ public partial class StrykerSettings : ToolOptions
[Argument(Format = "--msbuild-path {value}")] public string MsBuildPath => Get<string>(() => MsBuildPath);
/// <summary>Instruct Stryker to break execution when at least one test failed on initial test run.</summary>
[Argument(Format = "--break-on-initial-test-failure")] public bool? BreakOnInitialTestFailure => Get<bool?>(() => BreakOnInitialTestFailure);
/// <summary>Specifies the test runner to use for executing tests during mutation testing.<br><br>Available options:<br><br><ul><li>vstest - The traditional Visual Studio Test Platform runner (default)</li><li>mtp - The Microsoft Test Platform runner (preview)</li></ul><br><br>The MTP test runner is a modern alternative that provides better performance in certain scenarios and supports newer testing frameworks like TUnit. However, it's still in preview and may have limitations compared to the VsTest runner.</summary>
/// <summary>Specifies the test runner to use for executing tests during mutation testing.<br /><br />Available options:<br /><br /><ul><li>vstest - The traditional Visual Studio Test Platform runner (default)</li><li>mtp - The Microsoft Test Platform runner (preview)</li></ul><br /><br />The MTP test runner is a modern alternative that provides better performance in certain scenarios and supports newer testing frameworks like TUnit. However, it's still in preview and may have limitations compared to the VsTest runner.</summary>
[Argument(Format = "--test-runner {value}")] public StrykerTestRunner TestRunner => Get<StrykerTestRunner>(() => TestRunner);
/// <summary>When using the azure file storage provider you must pass credentials for the fileshare to Stryker. For authentication with the azure fileshare we support Shared Access Signatures (SAS).<br><br>The SAS should be configured with the following properties:<br><br>Allowed services: <preFile</pre><br>Allowed resource types: <pre>Container</pre, <pre>Object</pre><br>Allowed permissions: <pre>Read</pre>, <pre>Write</pre>, <pre>Create</pre><br><br>For more information on how to configure a SAS check the <a href="https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview">Azure documentation</a>.</summary>
/// <summary>When using the azure file storage provider you must pass credentials for the fileshare to Stryker. For authentication with the azure fileshare we support Shared Access Signatures (SAS).<br /><br />The SAS should be configured with the following properties:<br /><br />Allowed services: <c>File</c><br />Allowed resource types: <c>Container</c>, <c>Object</c><br />Allowed permissions: <c>Read</c>, <c>Write</c>, <c>Create</c><br /><br />For more information on how to configure a SAS check the <a href="https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview">Azure documentation</a>.</summary>
[Argument(Format = "--azure-fileshare-sas {value}")] public string AzureFileshareSas => Get<string>(() => AzureFileshareSas);
/// <summary>When using the S3 <a href="https://stryker-mutator.io/docs/stryker-net/configuration/#baselineprovider-string">provider</a> you must set the bucket name where baselines will be stored.<br><br>The baseline reports are stored under the key <pre>StrykerOutput/<version>/stryker-report.json</pre> within the bucket by default. If a <a href="https://stryker-mutator.io/docs/stryker-net/configuration/#project-infoname-string">project name</a> is set, the key becomes <pre>StrykerOutput/<projectName>/<version>/stryker-report.json</pre>.</summary>
/// <summary>When using the S3 <a href="https://stryker-mutator.io/docs/stryker-net/configuration/#baselineprovider-string">provider</a> you must set the bucket name where baselines will be stored.<br /><br />The baseline reports are stored under the key <c>StrykerOutput/&lt;version&gt;/stryker-report.json</c> within the bucket by default. If a <a href="https://stryker-mutator.io/docs/stryker-net/configuration/#project-infoname-string">project name</a> is set, the key becomes <c>StrykerOutput/&lt;projectName&gt;/&lt;version&gt;/stryker-report.json</c>.</summary>
[Argument(Format = "--s3-bucket-name {value}")] public string S3BucketName => Get<string>(() => S3BucketName);
/// <summary>When using the S3 <a href="https://stryker-mutator.io/docs/stryker-net/configuration/#baselineprovider-string">provider</a>, setting the region is optional. If not set, the AWS SDK resolves the region using its default configuration chain (for example environment variables or shared profiles).</summary>
[Argument(Format = "--s3-region {value}")] public string S3Region => Get<string>(() => S3Region);
/// <summary>When using a non-AWS S3-compatible service (e.g. MinIO, Backblaze B2) you can set a custom endpoint URL. This is optional; when not set the default AWS S3 endpoint is used.<br><br>Authentication uses the default AWS credential resolution chain (environment variables, shared credentials file, IAM role, etc.). For non-AWS services, set <pre>AWS_ACCESS_KEY_ID</pre> and <pre>AWS_SECRET_ACCESS_KEY</pre> environment variables.</summary>
/// <summary>When using a non-AWS S3-compatible service (e.g. MinIO, Backblaze B2) you can set a custom endpoint URL. This is optional; when not set the default AWS S3 endpoint is used.<br /><br />Authentication uses the default AWS credential resolution chain (environment variables, shared credentials file, IAM role, etc.). For non-AWS services, set <c>AWS_ACCESS_KEY_ID</c> and <c>AWS_SECRET_ACCESS_KEY</c> environment variables.</summary>
[Argument(Format = "--s3-endpoint {value}")] public string S3Endpoint => Get<string>(() => S3Endpoint);
}
#endregion
Expand Down
12 changes: 6 additions & 6 deletions src/Fallout.Common/Tools/Stryker/Stryker.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
"name": "Concurrency",
"type": "uint",
"format": "--concurrency {value}",
"help": "Change the amount of concurrent workers Stryker uses for the mutation testrun. Defaults to using half your logical (virtual) processor count.<p><strong>Example<strong>: an intel i7 quad-core with hyperthreading has 8 logical cores and 4 physical cores. Stryker will use 4 concurrent workers when using the default.</p>"
"help": "Change the amount of concurrent workers Stryker uses for the mutation testrun. Defaults to using half your logical (virtual) processor count.<p><strong>Example</strong>: an intel i7 quad-core with hyperthreading has 8 logical cores and 4 physical cores. Stryker will use 4 concurrent workers when using the default.</p>"
},
{
"name": "BreakAt",
Expand Down Expand Up @@ -131,7 +131,7 @@
"name": "Since",
"type": "string",
"format": "--since:{value}",
"help": "<p>Use git information to test only code changes since the given target. Stryker will only report on mutants within the changed code. All other mutants will not have a result.</p><p>If you wish to test only changed sources and tests but would like to have a complete mutation report see with-baseline.</p><p>Set the diffing target on the command line by passing a committish with the since flag in the format <c>--since:<committish></c>. Set the diffing target in the config file by setting the since target option.</p><p><i>* For changes on test project files all mutants covered by tests in that file will be seen as changed.</i></p>"
"help": "<p>Use git information to test only code changes since the given target. Stryker will only report on mutants within the changed code. All other mutants will not have a result.</p><p>If you wish to test only changed sources and tests but would like to have a complete mutation report see with-baseline.</p><p>Set the diffing target on the command line by passing a committish with the since flag in the format <c>--since:&lt;committish&gt;</c>. Set the diffing target in the config file by setting the since target option.</p><p><i>* For changes on test project files all mutants covered by tests in that file will be seen as changed.</i></p>"
},
{
"name": "Verbosity",
Expand Down Expand Up @@ -185,19 +185,19 @@
"type": "StrykerTestRunner",
"format": "--test-runner {value}",
"default": "vstest",
"help": "Specifies the test runner to use for executing tests during mutation testing.<br><br>Available options:<br><br><ul><li>vstest - The traditional Visual Studio Test Platform runner (default)</li><li>mtp - The Microsoft Test Platform runner (preview)</li></ul><br><br>The MTP test runner is a modern alternative that provides better performance in certain scenarios and supports newer testing frameworks like TUnit. However, it's still in preview and may have limitations compared to the VsTest runner."
"help": "Specifies the test runner to use for executing tests during mutation testing.<br /><br />Available options:<br /><br /><ul><li>vstest - The traditional Visual Studio Test Platform runner (default)</li><li>mtp - The Microsoft Test Platform runner (preview)</li></ul><br /><br />The MTP test runner is a modern alternative that provides better performance in certain scenarios and supports newer testing frameworks like TUnit. However, it's still in preview and may have limitations compared to the VsTest runner."
},
{
"name": "AzureFileshareSas",
"type": "string",
"format": "--azure-fileshare-sas {value}",
"help": "When using the azure file storage provider you must pass credentials for the fileshare to Stryker. For authentication with the azure fileshare we support Shared Access Signatures (SAS).<br><br>The SAS should be configured with the following properties:<br><br>Allowed services: <preFile</pre><br>Allowed resource types: <pre>Container</pre, <pre>Object</pre><br>Allowed permissions: <pre>Read</pre>, <pre>Write</pre>, <pre>Create</pre><br><br>For more information on how to configure a SAS check the <a href=\"https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview\">Azure documentation</a>."
"help": "When using the azure file storage provider you must pass credentials for the fileshare to Stryker. For authentication with the azure fileshare we support Shared Access Signatures (SAS).<br /><br />The SAS should be configured with the following properties:<br /><br />Allowed services: <c>File</c><br />Allowed resource types: <c>Container</c>, <c>Object</c><br />Allowed permissions: <c>Read</c>, <c>Write</c>, <c>Create</c><br /><br />For more information on how to configure a SAS check the <a href=\"https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview\">Azure documentation</a>."
},
{
"name": "S3BucketName",
"type": "string",
"format": "--s3-bucket-name {value}",
"help": "When using the S3 <a href=\"https://stryker-mutator.io/docs/stryker-net/configuration/#baselineprovider-string\">provider</a> you must set the bucket name where baselines will be stored.<br><br>The baseline reports are stored under the key <pre>StrykerOutput/<version>/stryker-report.json</pre> within the bucket by default. If a <a href=\"https://stryker-mutator.io/docs/stryker-net/configuration/#project-infoname-string\">project name</a> is set, the key becomes <pre>StrykerOutput/<projectName>/<version>/stryker-report.json</pre>."
"help": "When using the S3 <a href=\"https://stryker-mutator.io/docs/stryker-net/configuration/#baselineprovider-string\">provider</a> you must set the bucket name where baselines will be stored.<br /><br />The baseline reports are stored under the key <c>StrykerOutput/&lt;version&gt;/stryker-report.json</c> within the bucket by default. If a <a href=\"https://stryker-mutator.io/docs/stryker-net/configuration/#project-infoname-string\">project name</a> is set, the key becomes <c>StrykerOutput/&lt;projectName&gt;/&lt;version&gt;/stryker-report.json</c>."
},
{
"name": "S3Region",
Expand All @@ -209,7 +209,7 @@
"name": "S3Endpoint",
"type": "string",
"format": "--s3-endpoint {value}",
"help": "When using a non-AWS S3-compatible service (e.g. MinIO, Backblaze B2) you can set a custom endpoint URL. This is optional; when not set the default AWS S3 endpoint is used.<br><br>Authentication uses the default AWS credential resolution chain (environment variables, shared credentials file, IAM role, etc.). For non-AWS services, set <pre>AWS_ACCESS_KEY_ID</pre> and <pre>AWS_SECRET_ACCESS_KEY</pre> environment variables."
"help": "When using a non-AWS S3-compatible service (e.g. MinIO, Backblaze B2) you can set a custom endpoint URL. This is optional; when not set the default AWS S3 endpoint is used.<br /><br />Authentication uses the default AWS credential resolution chain (environment variables, shared credentials file, IAM role, etc.). For non-AWS services, set <c>AWS_ACCESS_KEY_ID</c> and <c>AWS_SECRET_ACCESS_KEY</c> environment variables."
}
]
}
Expand Down
Loading