NUnit2003
Consider using Assert.That(expr, Is.True) instead of ClassicAssert.IsTrue(expr)
Topic | Value |
---|---|
Id | NUnit2003 |
Severity | Info |
Enabled | True |
Category | Assertion |
Code | ClassicModelAssertUsageAnalyzer |
Description
Consider using the constraint model, Assert.That(expr, Is.True)
, instead of the classic model,
ClassicAssert.IsTrue(expr)
.
Motivation
The classic Assert model contains less flexibility than the constraint model,
so this analyzer marks usages of ClassicAssert.IsTrue
from the classic Assert model.
[Test]
public void Test()
{
ClassicAssert.IsTrue(expression);
}
How to fix violations
The analyzer comes with a code fix that will replace ClassicAssert.IsTrue(expression)
with
Assert.That(expression, Is.True)
. So the code block above will be changed into.
[Test]
public void Test()
{
Assert.That(expression, Is.True);
}
Configure severity
Via ruleset file
Configure the severity per project, for more info see MSDN.
Via .editorconfig file
# NUnit2003: Consider using Assert.That(expr, Is.True) instead of ClassicAssert.IsTrue(expr)
dotnet_diagnostic.NUnit2003.severity = chosenSeverity
where chosenSeverity
can be one of none
, silent
, suggestion
, warning
, or error
.
Via #pragma directive
#pragma warning disable NUnit2003 // Consider using Assert.That(expr, Is.True) instead of ClassicAssert.IsTrue(expr)
Code violating the rule here
#pragma warning restore NUnit2003 // Consider using Assert.That(expr, Is.True) instead of ClassicAssert.IsTrue(expr)
Or put this at the top of the file to disable all instances.
#pragma warning disable NUnit2003 // Consider using Assert.That(expr, Is.True) instead of ClassicAssert.IsTrue(expr)
Via attribute [SuppressMessage]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Assertion",
"NUnit2003:Consider using Assert.That(expr, Is.True) instead of ClassicAssert.IsTrue(expr)",
Justification = "Reason...")]