Skip to content

mstest0037.md

Latest commit

 

History

History
78 lines (54 loc) · 3.09 KB

mstest0037.md

File metadata and controls

78 lines (54 loc) · 3.09 KB
Raw
title MSTEST0037: 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 Yes
Default severity Info (Warning in 4.0)
Introduced in version 3.7.0
Is there a code fix Yes

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 alternatives provide better messages when they fail and are also easier to read.

How to fix violations

Use the better alternative method.

When to suppress warnings

If the assert is intended to verify the behavior of a user-defined operator, you can and should suppress the warning.

Suppress a warning

If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.

#pragma warning disable MSTEST0037
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0037

To disable the rule for a file, folder, or project, set its severity to none in the configuration file.

[*.{cs,vb}]
dotnet_diagnostic.MSTEST0037.severity = none

For more information, see How to suppress code analysis warnings.