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