Back to Nunit

NUnit2019

docs/articles/nunit-analyzers/NUnit2019.md

latest2.5 KB
Original Source

NUnit2019

Consider using Assert.That(expr, Is.Not.Null) instead of ClassicAssert.IsNotNull(expr)

TopicValue
IdNUnit2019
SeverityInfo
EnabledTrue
CategoryAssertion
CodeClassicModelAssertUsageAnalyzer

Description

Consider using the constraint model, Assert.That(expr, Is.Not.Null), instead of the classic model, ClassicAssert.IsNotNull(expr).

Motivation

The classic Assert model contains less flexibility than the constraint model, so this analyzer marks usages of ClassicAssert.IsNotNull from the classic Assert model.

csharp
[Test]
public void Test()
{
    object obj = null;
    ClassicAssert.IsNotNull(obj);
}

How to fix violations

The analyzer comes with a code fix that will replace ClassicAssert.IsNotNull(expression) with Assert.That(expression, Is.Not.Null). So the code block above will be changed into.

csharp
[Test]
public void Test()
{
    object obj = null;
    Assert.That(obj, Is.Not.Null);
}
<!-- start generated config severity -->

Configure severity

Via ruleset file

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

Via .editorconfig file

ini
# NUnit2019: Consider using Assert.That(expr, Is.Not.Null) instead of ClassicAssert.IsNotNull(expr)
dotnet_diagnostic.NUnit2019.severity = chosenSeverity

where chosenSeverity can be one of none, silent, suggestion, warning, or error.

Via #pragma directive

csharp
#pragma warning disable NUnit2019 // Consider using Assert.That(expr, Is.Not.Null) instead of ClassicAssert.IsNotNull(expr)
Code violating the rule here
#pragma warning restore NUnit2019 // Consider using Assert.That(expr, Is.Not.Null) instead of ClassicAssert.IsNotNull(expr)

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

csharp
#pragma warning disable NUnit2019 // Consider using Assert.That(expr, Is.Not.Null) instead of ClassicAssert.IsNotNull(expr)

Via attribute [SuppressMessage]

csharp
[System.Diagnostics.CodeAnalysis.SuppressMessage("Assertion",
    "NUnit2019:Consider using Assert.That(expr, Is.Not.Null) instead of ClassicAssert.IsNotNull(expr)",
    Justification = "Reason...")]
<!-- end generated config severity -->