-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Document MSTEST0039 and MSTEST0040 #44419
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.
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
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 may be deprecated in the future. | ||
Youssef1313 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## How to fix violations | ||
|
|
||
| Instead, use `Assert.ThrowsExactly` or `Assert.ThrowsExactlyAsync` instead of `Assert.ThrowsException` or `Assert.ThrowsExceptionAsync`. | ||
Youssef1313 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 hidden or 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, and may crash the process when using Microsoft.Testing.Platform or VSTest under modern .NET, or even be silently swallowed in cases where a custom `SynchronizationContext` is present that catches the exception. | ||
Youssef1313 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.