-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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
Document MSTEST0037 analyzer #43601
Open
Youssef1313
wants to merge
1
commit into
dotnet:main
Choose a base branch
from
Youssef1313:mstest0037-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+62
−0
Open
Document MSTEST0037 analyzer #43601
Changes from all commits
Commits
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 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,59 @@ | ||
--- | ||
title: "Use proper 'Assert' methods" | ||
description: "Learn about code analysis rule MSTEST0037: Use proper 'Assert' methods." | ||
ms.date: 11/17/2024 | ||
f1_keywords: | ||
- MSTEST0037 | ||
- UseProperAssertMethodsAnalyzer | ||
helpviewer_keywords: | ||
- UseProperAssertMethodsAnalyzer | ||
- MSTEST0037 | ||
author: Youssef1313 | ||
ms.author: ygerges | ||
--- | ||
# MSTEST0037: Use proper 'Assert' methods | ||
|
||
| Property | Value | | ||
|-------------------------------------|------------------------------------------------------------------------| | ||
| **Rule ID** | MSTEST0037 | | ||
| **Title** | Use proper 'Assert' methods | | ||
| **Category** | Usage | | ||
| **Fix is breaking or non-breaking** | Non-breaking | | ||
| **Enabled by default** | No | | ||
| **Default severity** | Info | | ||
| **Introduced in version** | 3.7.0 | | ||
| **There is a code fix** | No | | ||
|
||
## Cause | ||
|
||
The use of <xref:Microsoft.VisualStudio.TestTools.UnitTesting.Assert> methods in a specific way when there is a better alternative. | ||
|
||
## Rule description | ||
|
||
There are multiple cases where you get this warning: | ||
|
||
- The use of `Assert.IsTrue(<expression> == null)` (with all combinations, like `IsFalse`, `!= null`, `is null`, or `is not null`). | ||
|
||
Using `Assert.IsNull(<expression>)` or `Assert.IsNotNull(<expression>)` is a better alternative. | ||
|
||
- The use of `Assert.IsTrue(<expression1> == <expression2>)` (with all combinations, like `IsFalse` or `!=`). | ||
|
||
Using `Assert.AreEqual(<expression1>, <expression2>)` or `Assert.AreNotEqual(<expression1>, <expression2>)` is a better alternative. | ||
|
||
- The use of `Assert.AreEqual(true, <expression>)` or `Assert.AreEqual(false, <expression>)`. | ||
|
||
Using `Assert.IsTrue(<expression>)` or `Assert.IsFalse(<expression>)` is a better alternative. | ||
|
||
- The use of `Assert.AreEqual(null, <expression>)` or `Assert.AreNotEqual(null, <expression>)`. | ||
|
||
Using `Assert.IsNull(<expression>)` or `Assert.IsNotNull<expression>` is a better alternative. | ||
|
||
In many cases, the better alternative provides better messages when they fail and are also easier to read. | ||
|
||
## How to fix violations | ||
|
||
Use the better alternative method. | ||
|
||
## When to suppress warnings | ||
|
||
You usually don't want to suppress warnings from this rule if you decided to opt-in for it. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we change the analyzer to become enabled by default, then it's no longer opt-in and will need to adjust the wording here. |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May change depending on the discussion outcome in https://github.com/microsoft/testfx/pull/4052/files#r1845291274