-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document MSTEST0039 and MSTEST0040 (#44419)
* Document MSTEST0039 and MSTEST0040 * Fix markdownlint violation * Reword * Update further * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> --------- Co-authored-by: Genevieve Warren <[email protected]>
- Loading branch information
1 parent
5452826
commit 295d55a
Showing
8 changed files
with
92 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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 |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: "MSTEST0039: Use newer 'Assert.Throws' methods" | ||
description: "Learn about code analysis rule MSTEST0039: Use 'Assert.ThrowsExactly' instead of 'Assert.ThrowsException'" | ||
ms.date: 01/17/2025 | ||
f1_keywords: | ||
- MSTEST0039 | ||
- UseNewerAssertThrowsAnalyzer | ||
helpviewer_keywords: | ||
- UseNewerAssertThrowsAnalyzer | ||
- MSTEST0039 | ||
author: Youssef1313 | ||
ms.author: ygerges | ||
--- | ||
# MSTEST0039: Use newer 'Assert.Throws' methods | ||
|
||
| Property | Value | | ||
|-------------------------------------|------------------------------------------------------------------------| | ||
| **Rule ID** | MSTEST0039 | | ||
| **Title** | Use newer 'Assert.Throws' methods | | ||
| **Category** | Usage | | ||
| **Fix is breaking or non-breaking** | Non-breaking | | ||
| **Enabled by default** | Yes | | ||
| **Default severity** | Info | | ||
| **Introduced in version** | 3.8.0 | | ||
| **Is there a code fix** | Yes | | ||
|
||
## Cause | ||
|
||
The use of <xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert.ThrowsException*?displayProperty=nameWithType> or <xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert.ThrowsExceptionAsync*?displayProperty=nameWithType>, which are no longer recommended. | ||
|
||
## Rule description | ||
|
||
<xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert.ThrowsException*?displayProperty=nameWithType> and <xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert.ThrowsExceptionAsync*?displayProperty=nameWithType> are not recommended and might be deprecated in the future. | ||
|
||
## How to fix violations | ||
|
||
Use `Assert.ThrowsExactly` or `Assert.ThrowsExactlyAsync` instead of `Assert.ThrowsException` or `Assert.ThrowsExceptionAsync`. | ||
|
||
## When to suppress warnings | ||
|
||
Do not suppress a warning from this rule. It's strongly recommended to move from the old APIs to the new ones. |
This file contains 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 |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: "MSTEST0040: Do not assert inside 'async void' contexts" | ||
description: "Learn about code analysis rule MSTEST0040: Do not assert inside 'async void' methods, local functions, or lambdas because they may not fail the test" | ||
ms.date: 01/17/2025 | ||
f1_keywords: | ||
- MSTEST0040 | ||
- AvoidUsingAssertsInAsyncVoidContextAnalyzer | ||
helpviewer_keywords: | ||
- AvoidUsingAssertsInAsyncVoidContextAnalyzer | ||
- MSTEST0040 | ||
author: Youssef1313 | ||
ms.author: ygerges | ||
--- | ||
# MSTEST0040: Do not assert inside 'async void' contexts | ||
|
||
| Property | Value | | ||
|-------------------------------------|------------------------------------------------------------------------| | ||
| **Rule ID** | MSTEST0040 | | ||
| **Title** | Do not assert inside 'async void' contexts | | ||
| **Category** | Usage | | ||
| **Fix is breaking or non-breaking** | Non-breaking | | ||
| **Enabled by default** | Yes | | ||
| **Default severity** | Warning | | ||
| **Introduced in version** | 3.8.0 | | ||
| **Is there a code fix** | No | | ||
|
||
## Cause | ||
|
||
The use of any assertion method in an `async void` method, local function, or lambda. | ||
|
||
## Rule description | ||
|
||
Exceptions that are thrown in an `async void` context are unhandled. A failing assertion in an `async void` method will be swallowed and will not crash the process when using VSTest under .NET Framework. Under .NET, a failing assertion in an `async void` method might crash the process when using Microsoft.Testing.Platform or VSTest. In cases where a custom `SynchronizationContext` is present that catches the exception, the failing assertion might be silently swallowed. | ||
|
||
## How to fix violations | ||
|
||
Refactor the code to not use assertions in `async void`. | ||
|
||
## When to suppress warnings | ||
|
||
Do not suppress a warning from this rule. |
This file contains 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
This file contains 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