Skip to content

Commit 3075c78

Browse files
authored
Add docs for --maximum-failed-tests (#43939)
1 parent 9f293fb commit 3075c78

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/core/testing/unit-testing-platform-exit-codes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ ms.topic: reference
2626
| `10` | The exit code `10` indicates that the test adapter, Testing.Platform Test Framework, MSTest, NUnit, or xUnit, failed to run tests for an infrastructure reason unrelated to the test's self. An example is failing to create a fixture needed by tests. |
2727
| `11` | The exit code `11` indicates that the test process will exit if dependent process exits. |
2828
| `12` | The exit code `12` indicates that the test session was unable to run because the client does not support any of the supported protocol versions. |
29+
| `13` | The exit code `13` indicates that the test session was stopped due to reaching the specified number of maximum failed tests using `--maximum-failed-tests` command-line option. For more information, see [the Options section in Microsoft.Testing.Platform overview](unit-testing-platform-intro.md#options) |
2930

3031
To enable verbose logging and troubleshoot issues, see [Microsoft.Testing.Platform Diagnostics extensions](unit-testing-platform-extensions-diagnostics.md#built-in-options).
3132

docs/core/testing/unit-testing-platform-intro.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,13 @@ The list below described only the platform options. To see the specific options
261261

262262
List available tests. Tests will not be executed.
263263

264+
- **`--maximum-failed-tests`**
265+
266+
Specifies the maximum number of tests failures that, when reached, will stop the test run. Support for this switch requires framework authors to implement the `IGracefulStopTestExecutionCapability` capability. The exit code when reaching that amount of test failures is 13. For more information, see [Microsoft.Testing.Platform exit codes](unit-testing-platform-exit-codes.md).
267+
268+
> [!NOTE]
269+
> This feature is available in Microsoft.Testing.Platform starting with version 1.5.
270+
264271
- **`--minimum-expected-tests`**
265272

266273
Specifies the minimum number of tests that are expected to run. By default, at least one test is expected to run.

0 commit comments

Comments
 (0)