MSTEST0017:断言参数应按正确的顺序传递

属性
规则 ID MSTEST0017
标题 断言参数应按正确的顺序传递
类别 使用情况
修复是中断修复还是非中断修复 非中断
默认为启用
默认严重性 信息
引入版本 3.4.0
是否存在代码修补程序

原因

Assert.AreEqualAssert.AreNotEqualAssert.AreSameAssert.AreNotSame 的调用遵循以下一个或多个模式时,此规则引发问题:

  • actual 参数是一个常量或文本值
  • actual 参数变量以 expected_expectedExpected 开头
  • expectednotExpected 参数变量以 actual 开头
  • actual 不是局部变量

规则说明

MSTest Assert.AreEqualAssert.AreNotEqualAssert.AreSameAssert.AreNotSame 预期第一个参数为预期/非预期值,第二个参数为实际值。

预期值和实际值的顺序错误不会改变测试的结果(在应该成功/失败时成功/失败),但是断言失败将包含误导性信息。

如何解决冲突

确保按正确的顺序传递 actualexpected/notExpected 参数。

何时禁止显示警告

请勿禁止显示此规则的警告,因为这会导致误导性输出。

抑制警告

如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。

#pragma warning disable MSTEST0017
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0017

若要对文件、文件夹或项目禁用该规则,请在配置文件中将其严重性设置为 none

[*.{cs,vb}]
dotnet_diagnostic.MSTEST0017.severity = none

有关详细信息,请参阅如何禁止显示代码分析警告