MSTEST0026:避免断言中的条件访问

属性
规则 ID MSTEST0026
标题 避免断言中的条件访问
类别 使用情况
修复是中断修复还是非中断修复 非中断
默认为启用 是(从 3.5 到 3.7)。 无(从 3.8 开始)
默认严重性 信息
引入版本 3.5.0
是否存在代码修补程序

原因

在将包含 null 条件运算符(?.)?[] 的参数传递给以下断言方法时,此规则将引发诊断:

  • Assert.IsTrue
  • Assert.IsFalse
  • Assert.AreEqual
  • Assert.AreNotEqual
  • Assert.AreSame
  • Assert.AreNotSame
  • CollectionAssert.AreEqual
  • CollectionAssert.AreNotEqual
  • CollectionAssert.AreEquivalent
  • CollectionAssert.AreNotEquivalent
  • CollectionAssert.Contains
  • CollectionAssert.DoesNotContain
  • CollectionAssert.AllItemsAreNotNull
  • CollectionAssert.AllItemsAreUnique
  • CollectionAssert.AllItemsAreInstancesOfType
  • CollectionAssert.IsSubsetOf
  • CollectionAssert.IsNotSubsetOf
  • StringAssert.Contains
  • StringAssert.StartsWith
  • StringAssert.EndsWith
  • StringAssert.Matches
  • StringAssert.DoesNotMatch

规则说明

单元测试中的断言的目的是验证是否满足某些条件。 在断言中使用条件访问运算符时,它会引入可能满足或可能不满足的其他条件,具体取决于要访问的对象的状态。 这可能会导致测试结果不一致,使测试不太清晰。

如何解决冲突

请确保参数在传递给断言方法时不包含 (?.)?[]。 相反,请在进行断言之前执行 null 检查。

Company? company = GetCompany();
Assert.AreEqual("Contoso", company?.Name); // MSTEST0026
StringAssert.Contains(company?.Address, "Brazil"); // MSTEST0026

// Fixed code
Assert.IsNotNull(company);
Assert.AreEqual("Contoso", company.Name);
StringAssert.Contains(company.Address, "Brazil");

何时禁止显示警告

建议不要禁止显示此规则的警告。

抑制警告

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

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

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

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

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