NUnit2010

NUnit2010

Use EqualConstraint.

Topic	Value
Id	NUnit2010
Severity	Info
Enabled	True
Category	Assertion
Code	EqualConstraintUsageAnalyzer

Description

Using EqualConstraint will lead to better assertion messages in case of failure.

Motivation

Using Is.EqualTo (or Is.Not.EqualTo) constraint will lead to better assertion messages in case of failure, so this analyzer marks all usages of == operator and Equals method where it is possible to replace with Is.EqualTo constraint.

[Test]
public void Test()
{
    Assert.True(actual == expected);
}

How to fix violations

The analyzer comes with a code fix that will replace Assert.True(actual == expected) with Assert.That(actual, Is.EqualTo(expected)). So the code block above will be changed into

[Test]
public void Test()
{
    Assert.That(actual, Is.EqualTo(expected));
}

Configure severity

Via ruleset file.

Configure the severity per project, for more info see MSDN.

Via #pragma directive.

#pragma warning disable NUnit2010 // Use EqualConstraint.
Code violating the rule here
#pragma warning restore NUnit2010 // Use EqualConstraint.

Or put this at the top of the file to disable all instances.

#pragma warning disable NUnit2010 // Use EqualConstraint.

Via attribute [SuppressMessage].

[System.Diagnostics.CodeAnalysis.SuppressMessage("Assertion", 
    "NUnit2010:Use EqualConstraint.",
    Justification = "Reason...")]