Skip to content

Update MSTest.Sdk docs to note IsTestApplication MSBuild property #48016

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
merged 1 commit into from
Aug 20, 2025
Merged

Update MSTest.Sdk docs to note IsTestApplication MSBuild property #48016

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
18 changes: 11 additions & 7 deletions docs/core/testing/unit-testing-mstest-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ By default, the MSTest SDK discovers and runs your tests using the [MSTest runne
You can enable `MSTest.Sdk` in a project by simply updating the `Sdk` attribute of the `Project` node of your project:

```xml
<Project Sdk="MSTest.Sdk/3.8.3">
<Project Sdk="MSTest.Sdk/3.10.2">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
Expand All @@ -29,7 +29,7 @@ You can enable `MSTest.Sdk` in a project by simply updating the `Sdk` attribute
```

> [!NOTE]
> `/3.8.3` is given as example and can be replaced with any newer version.
> `/3.10.2` is given as example and can be replaced with any newer version.

To simplify handling of versions, we recommend setting the SDK version at solution level using the _global.json_ file. For example, your project file would look like:

Expand All @@ -48,7 +48,7 @@ Then, specify the `MSTest.Sdk` version in the _global.json_ file as follows:
```json
{
"msbuild-sdks": {
"MSTest.Sdk": "3.8.3"
"MSTest.Sdk": "3.10.2"
}
}
```
Expand All @@ -63,6 +63,10 @@ You don't need anything else to build and run your tests and you can use the sam
> By switching to the `MSTest.Sdk`, you opt in to using the [MSTest runner (enables Microsoft.Testing.Platform for MSTest)](./unit-testing-mstest-runner-intro.md), including with [dotnet test](./microsoft-testing-platform-integration-dotnet-test.md). That requires modifying your CI and local CLI calls, and also impacts the available entries of the _.runsettings_. You can use `MSTest.Sdk` and still keep the old integrations and tools by instead switching the [runner](#select-the-runner).
> By default, MSTest.Sdk sets `EnableMSTestRunner` and `TestingPlatformDotnetTestSupport` to true. For more information about dotnet test and its different modes for running Microsoft.Testing.Platform, see [Testing with dotnet test](./unit-testing-with-dotnet-test.md).

## Test utility helper libraries

If the project that uses MSTest.Sdk is intended to be a test utility helper library, and doesn't by itself contain any runnable tests, the project should have `<IsTestApplication>false</IsTestApplication>`.

## Select the runner

By default, MSTest SDK relies on [Microsoft.Testing.Platform](./unit-testing-mstest-runner-intro.md), but you can switch to [VSTest](/visualstudio/test/vstest-console-options) by adding the property `<UseVSTest>true</UseVSTest>`.
Expand Down Expand Up @@ -111,7 +115,7 @@ You can set the profile using the property `TestingExtensionsProfile` with one o
Here's a full example, using the `None` profile:

```xml
<Project Sdk="MSTest.Sdk/3.8.3">
<Project Sdk="MSTest.Sdk/3.10.2">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
Expand All @@ -138,7 +142,7 @@ Extensions can be enabled and disabled by MSBuild properties with the pattern `E
For example, to enable the crash dump extension (NuGet package [Microsoft.Testing.Extensions.CrashDump](https://www.nuget.org/packages/Microsoft.Testing.Extensions.CrashDump)), you can use the following property `EnableMicrosoftTestingExtensionsCrashDump` set to `true`:

```xml
<Project Sdk="MSTest.Sdk/3.8.3">
<Project Sdk="MSTest.Sdk/3.10.2">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
Expand All @@ -160,7 +164,7 @@ This property pattern can be used to enable an additional extension on top of th
You can also disable an extension that's coming from the selected profile. For example, disable the `MS Code Coverage` extension by setting `<EnableMicrosoftTestingExtensionsCodeCoverage>false</EnableMicrosoftTestingExtensionsCodeCoverage>`:

```xml
<Project Sdk="MSTest.Sdk/3.8.3">
<Project Sdk="MSTest.Sdk/3.10.2">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
Expand Down Expand Up @@ -232,7 +236,7 @@ Add the version to your `global.json`:
```json
{
"msbuild-sdks": {
"MSTest.Sdk": "3.8.3"
"MSTest.Sdk": "3.10.2"
}
}
```
Expand Down
Loading