docs/articles/nunit-analyzers/NUnit1031.md
| Topic | Value |
|---|---|
| Id | NUnit1031 |
| Severity | Error |
| Enabled | True |
| Category | Structure |
| Code | ValuesUsageAnalyzer |
The individual arguments provided by a ValuesAttribute must match the type of the corresponding parameter of the method.
To prevent tests that will fail at runtime due to improper construction.
[Test]
public void SampleTest([Values(0.0, 1.0)] int numberValue)
{
Assert.That(numberValue, Is.AnyOf(0, 1));
}
In the test above, numberValue is declared as an integer. However, [Values(0.0, 1.0)] provides values as doubles.
This will lead to a runtime failure.
Ensure that the type of the objects used by the ValuesAttribute matches that of the parameter.
So, this fix would be acceptable:
// Both use type int.
[Test]
public void SampleTest([Values(0, 1)] int numberValue)
{
Assert.That(numberValue, Is.AnyOf(0, 1));
}
And this would also work:
// Both use type double
[Test]
public void SampleTest([Values(0.0, 1.0)] double numberValue)
{
Assert.That(numberValue, Is.AnyOf(0, 1));
}
Configure the severity per project, for more info see MSDN.
# NUnit1031: The individual arguments provided by a ValuesAttribute must match the type of the corresponding parameter of the method
dotnet_diagnostic.NUnit1031.severity = chosenSeverity
where chosenSeverity can be one of none, silent, suggestion, warning, or error.
#pragma warning disable NUnit1031 // The individual arguments provided by a ValuesAttribute must match the type of the corresponding parameter of the method
Code violating the rule here
#pragma warning restore NUnit1031 // The individual arguments provided by a ValuesAttribute must match the type of the corresponding parameter of the method
Or put this at the top of the file to disable all instances.
#pragma warning disable NUnit1031 // The individual arguments provided by a ValuesAttribute must match the type of the corresponding parameter of the method
[SuppressMessage][System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1031:The individual arguments provided by a ValuesAttribute must match the type of the corresponding parameter of the method",
Justification = "Reason...")]