docs/articles/nunit-analyzers/NUnit2014.md
| Topic | Value |
|---|---|
| Id | NUnit2014 |
| Severity | Info |
| Enabled | True |
| Category | Assertion |
| Code | SomeItemsConstraintUsageAnalyzer |
Using SomeItemsConstraint will lead to better assertion messages in case of failure.
Using Does.Contain (or Does.Not.Contain) constraint will lead to better assertion messages in case of failure,
so this analyzer marks all usages of string Contains method where it is possible to replace
with Does.Contain constraint.
[Test]
public void Test()
{
var actual = new List<int> {1,2,3};
int expected = 1;
ClassicAssert.True(actual.Contains(expected));
}
The analyzer comes with a code fix that will replace ClassicAssert.True(actual.Contains(expected)) with
Assert.That(actual, Does.Contain(expected)). So the code block above will be changed into
[Test]
public void Test()
{
var actual = new List<int> {1,2,3};
int expected = 1;
Assert.That(actual, Does.Contain(expected));
}
Configure the severity per project, for more info see MSDN.
# NUnit2014: Use SomeItemsConstraint for better assertion messages in case of failure
dotnet_diagnostic.NUnit2014.severity = chosenSeverity
where chosenSeverity can be one of none, silent, suggestion, warning, or error.
#pragma warning disable NUnit2014 // Use SomeItemsConstraint for better assertion messages in case of failure
Code violating the rule here
#pragma warning restore NUnit2014 // Use SomeItemsConstraint for better assertion messages in case of failure
Or put this at the top of the file to disable all instances.
#pragma warning disable NUnit2014 // Use SomeItemsConstraint for better assertion messages in case of failure
[SuppressMessage][System.Diagnostics.CodeAnalysis.SuppressMessage("Assertion",
"NUnit2014:Use SomeItemsConstraint for better assertion messages in case of failure",
Justification = "Reason...")]