Split dotnet test docs #50256
Split dotnet test docs #50256
Conversation
Evangelink
force-pushed
the
dev/amauryleve/dotnet-test
branch
from
e41112a to
1e3d9d5
Compare
There was a problem hiding this comment.
Pull request overview
This PR splits the dotnet test documentation from a single page with tabs into separate pages for better clarity and navigation. The main dotnet-test.md file now serves as an overview that directs users to specific documentation for VSTest and Microsoft Testing Platform (MTP).
Key Changes
- Restructured the main
dotnet-test.mdto provide an overview with guidance on choosing between test runners - Created
dotnet-test-vstest.mdcontaining comprehensive VSTest-specific documentation - Created
dotnet-test-mtp.mdcontaining Microsoft Testing Platform-specific documentation
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| docs/core/tools/dotnet-test.md | Converted from comprehensive reference to overview page with test runner selection guidance |
| docs/core/tools/dotnet-test-vstest.md | New file containing all VSTest-specific command-line options, examples, and documentation (applies to .NET 6 SDK and later) |
| docs/core/tools/dotnet-test-mtp.md | New file containing all MTP-specific command-line options, examples, and documentation (applies to .NET 10 SDK and later) |
| docs/navigate/tools-diagnostics/toc.yml | Updated table of contents to include the new sub-pages under dotnet test |
| ``` | ||
|
|
||
| The short form `-p` can be used for `--property`. The same applies for `/property:property=value` and its short form is `/p`. | ||
| More informatiom about the available arguments can be found in [the dotnet msbuild documentation](dotnet-msbuild.md). |
There was a problem hiding this comment.
Spelling error: "informatiom" should be "information"
| More informatiom about the available arguments can be found in [the dotnet msbuild documentation](dotnet-msbuild.md). | |
| More information about the available arguments can be found in [the dotnet msbuild documentation](dotnet-msbuild.md). |
| - 5400s, 5400sec, 5400second, 5400seconds | ||
| - 5400000ms, 5400000mil, 5400000millisecond, 5400000milliseconds | ||
|
|
||
| When no unit is used (for example, 5400000), the value is assumed to be in milliseconds. When used together with data driven tests, the timeout behavior depends on the test adapter used. For xUnit, NUnit. and MSTest 2.2.4+, the timeout is renewed after every test case. For MSTest before version 2.2.4, the timeout is used for all test cases. This option is supported on Windows with `netcoreapp2.1` and later, on Linux with `netcoreapp3.1` and later, and on macOS with `net5.0` or later. Implies `--blame` and `--blame-hang`. |
There was a problem hiding this comment.
Missing Oxford comma: In the list "For xUnit, NUnit. and MSTest 2.2.4+", there should be a comma before "and". It should be "For xUnit, NUnit, and MSTest 2.2.4+". Also note there's an extra period after "NUnit" that should be a comma.
| - [Microsoft.Testing.Platform](../../../docs/core/testing/microsoft-testing-platform-intro.md) | ||
| - [Microsoft.Testing.Platform extensions](../../../docs/core/testing/microsoft-testing-platform-extensions.md) |
There was a problem hiding this comment.
Incorrect relative link paths: The links should use relative paths from the current file location without the redundant path prefix. Change from "../../../docs/core/testing/microsoft-testing-platform-intro.md" to "../testing/microsoft-testing-platform-intro.md" and from "../../../docs/core/testing/microsoft-testing-platform-extensions.md" to "../testing/microsoft-testing-platform-extensions.md".
| - [Microsoft.Testing.Platform](../../../docs/core/testing/microsoft-testing-platform-intro.md) | |
| - [Microsoft.Testing.Platform extensions](../../../docs/core/testing/microsoft-testing-platform-extensions.md) | |
| - [Microsoft.Testing.Platform](../testing/microsoft-testing-platform-intro.md) | |
| - [Microsoft.Testing.Platform extensions](../testing/microsoft-testing-platform-extensions.md) |
|
|
||
| - **`-e|--environment <NAME="VALUE">`** | ||
|
|
||
| Sets the value of an environment variable. Creates the variable if it does not exist, overrides if it does exist. Use of this option will force the tests to be run in an isolated process. The option can be specified multiple times to provide multiple variables. |
There was a problem hiding this comment.
Missing contraction: According to the Markdown writing style guidelines, use contractions for a conversational tone. Change "does not" to "doesn't" in both occurrences.
|
|
||
| - **`--no-launch-profile`** | ||
|
|
||
| Do not attempt to use launchSettings.json to configure the application. By default, `launchSettings.json` is used, which can apply environment variables and command-line arguments to the test executable. |
There was a problem hiding this comment.
Missing contraction: According to the Markdown writing style guidelines, use contractions for a conversational tone. Change "Do not" to "Don't" at the start of the sentence.
|
|
||
| - **`--test-modules <EXPRESSION>`** | ||
|
|
||
| Filters test modules using file globbing in .NET. Only tests belonging to those test modules will run. For more information and examples on how to use file globbing in .NET, see [File globbing](../../../docs/core/extensions/file-globbing.md). |
There was a problem hiding this comment.
Incorrect relative link path: The link should use a relative path from the current file location without the redundant path prefix. Change from "../../../docs/core/extensions/file-globbing.md" to "../../extensions/file-globbing.md" since this file is in docs/core/tools/ and the target is in docs/core/extensions/.
| Filters test modules using file globbing in .NET. Only tests belonging to those test modules will run. For more information and examples on how to use file globbing in .NET, see [File globbing](../../../docs/core/extensions/file-globbing.md). | |
| Filters test modules using file globbing in .NET. Only tests belonging to those test modules will run. For more information and examples on how to use file globbing in .NET, see [File globbing](../extensions/file-globbing.md). |
|
|
||
| - **`args`** | ||
|
|
||
| Specifies extra arguments to pass to the test application(s). Use a space to separate multiple arguments. For more information and examples on what to pass, see [Microsoft.Testing.Platform overview](../../../docs/core/testing/microsoft-testing-platform-intro.md) and [Microsoft.Testing.Platform extensions](../../../docs/core/testing/microsoft-testing-platform-extensions.md). |
There was a problem hiding this comment.
Incorrect relative link paths: The links should use relative paths from the current file location without the redundant path prefix. Change from "../../../docs/core/testing/microsoft-testing-platform-intro.md" to "../testing/microsoft-testing-platform-intro.md" and from "../../../docs/core/testing/microsoft-testing-platform-extensions.md" to "../testing/microsoft-testing-platform-extensions.md".
| Specifies extra arguments to pass to the test application(s). Use a space to separate multiple arguments. For more information and examples on what to pass, see [Microsoft.Testing.Platform overview](../../../docs/core/testing/microsoft-testing-platform-intro.md) and [Microsoft.Testing.Platform extensions](../../../docs/core/testing/microsoft-testing-platform-extensions.md). | |
| Specifies extra arguments to pass to the test application(s). Use a space to separate multiple arguments. For more information and examples on what to pass, see [Microsoft.Testing.Platform overview](../testing/microsoft-testing-platform-intro.md) and [Microsoft.Testing.Platform extensions](../testing/microsoft-testing-platform-extensions.md). |
|
|
||
| Runs the tests in blame mode. This option is helpful in isolating problematic tests that cause the test host to crash. When a crash is detected, it creates a sequence file in `TestResults/<Guid>/<Guid>_Sequence.xml` that captures the order of tests that were run before the crash. | ||
|
|
||
| This option does not create a memory dump and is not helpful when the test is hanging. |
There was a problem hiding this comment.
Missing contractions: According to the Markdown writing style guidelines, use contractions for a conversational tone. Change "does not" to "doesn't" and "is not" to "isn't".
|
|
||
| > [!NOTE] | ||
| > You can use only one of the following options at a time: `--project`, `--solution`, or `--test-modules`. These options can't be combined. | ||
| > In addition, when using `--test-modules`, you can't specify `--arch`, `--configuration`, `--framework`, `--os`, or `--runtime`. These options are not relevant for an already-built module. |
There was a problem hiding this comment.
Missing contraction: According to the Markdown writing style guidelines, use contractions for a conversational tone. Change "are not" to "aren't".
| Short form `-r` available starting in .NET SDK 7. | ||
|
|
||
| > [!NOTE] | ||
| > Running tests for a solution with a global `RuntimeIdentifier` property (explicitly or via `--arch`, `--runtime`, or `--os`) is not supported. Set `RuntimeIdentifier` on an individual project level instead. |
There was a problem hiding this comment.
Missing contraction: According to the Markdown writing style guidelines, use contractions for a conversational tone. Change "is not" to "isn't".
Summary
Split
dotnet testdocs into sub pages rather than tabs to simplify understanding and browsability.Fixes #50234
Internal previews